Ferreteria/install: Difference between revisions
Jump to navigation
Jump to search
m (10 revisions imported: moving this project here) |
m (wiki link updates) |
||
| Line 1: | Line 1: | ||
==Summary== | ==Summary== | ||
* Clone the [https://gitlab.com/woozalia/ferreteria Ferreteria Git repository] into a folder of your choice, which we'll call {{arg|ferreteria base}}. | * Clone the [https://gitlab.com/woozalia/ferreteria Ferreteria Git repository] into a folder of your choice, which we'll call {{arg|ferreteria base}}. | ||
** My [[ | ** My [[Conventions/vdomain|standard location]] for this is <code>/home/{{arg|user}}/site/git/ferreteria/</code>. | ||
* Copy the <code>{{arg|ferreteria base}}/config</code> folder to a location outside of <code>[ferreteria base]</code>. | * Copy the <code>{{arg|ferreteria base}}/config</code> folder to a location outside of <code>[ferreteria base]</code>. | ||
** We'll call this new location <code>{{arg|local config}}</code>. | ** We'll call this new location <code>{{arg|local config}}</code>. | ||
** My [[ | ** My [[Conventions/vdomain|standard location]] for this is <code>/home/{{arg|user}}/site/config/ferreteria</code> | ||
* Optional: Modify each file to match your local environment, according to instructions in each file. | * Optional: Modify each file to match your local environment, according to instructions in each file. | ||
** There's currently only one file, <code>const.php</code>, and it normally won't need modifying. | ** There's currently only one file, <code>const.php</code>, and it normally won't need modifying. | ||
| Line 13: | Line 13: | ||
* '''{{arg|$ft}}''' = the Ferreteria base folder (My convention: {{arg|$HOME}}/site/git/ferreteria) | * '''{{arg|$ft}}''' = the Ferreteria base folder (My convention: {{arg|$HOME}}/site/git/ferreteria) | ||
See [[ | See [[conventions/vdomain]] for more explanation. | ||
===Preparation=== | ===Preparation=== | ||
You'll need to have {{arg|$USER}}'s account set up with an [[ssh]] key that can access GitLab. At least, I ''think'' that's the requirement. It might be more GitLab-project-specific. | You'll need to have {{arg|$USER}}'s account set up with an [[ssh]] key that can access GitLab. At least, I ''think'' that's the requirement. It might be more GitLab-project-specific. | ||
Revision as of 18:12, 11 June 2022
Summary
- Clone the Ferreteria Git repository into a folder of your choice, which we'll call <ferreteria base>.
- My standard location for this is
/home/<user>/site/git/ferreteria/.
- My standard location for this is
- Copy the
<ferreteria base>/configfolder to a location outside of[ferreteria base].- We'll call this new location
<local config>. - My standard location for this is
/home/<user>/site/config/ferreteria
- We'll call this new location
- Optional: Modify each file to match your local environment, according to instructions in each file.
- There's currently only one file,
const.php, and it normally won't need modifying.
- There's currently only one file,
Details
I'll use the following shorthand:
- <$HOME> = the home folder for all of the domain-user's files
- <$WEB> = the public HTML folder (typically
public_htmlorwww) inside <$HOME> - <$ft> = the Ferreteria base folder (My convention: <$HOME>/site/git/ferreteria)
See conventions/vdomain for more explanation.
Preparation
You'll need to have <$USER>'s account set up with an ssh key that can access GitLab. At least, I think that's the requirement. It might be more GitLab-project-specific.
Steps
These instructions assume some common-sense understandings (generally: if a thing has already been done outside of these instructions, you don't need to do it again here).
| Action / Intention | Commands | Where You End Up |
|---|---|---|
| Make sure you're in the right place as the right user. | ||
cd <$HOME> su <$USER> |
<$HOME> | |
| Set up some folders. | ||
mkdir site cd site mkdir git cd git |
<$HOME>/site/git
| |
| Clone the Ferreteria repository. | ||
git clone git@gitlab.com:woozalia/ferreteria.git cd .. |
<$HOME>/site
| |
| Create the site's config folder. | ||
mkdir config cd config |
<$HOME>/site/config
| |
| Copy config files from the repository into the config folder, where you can make changes. | ||
cp -R ../git/ferreteria/config ferreteria cd .. mkdir dropins cd dropins |
<$HOME>/site/dropins
| |
| Link from within the site-wide dropins folder to specific Ferreteria dropins you want to use. | ||
ln -rs ../git/ferreteria/dropins/basics basics ln -rs ../git/ferreteria/dropins/users users ln -rs ../git/ferreteria/dropins/wiki wiki | ||
|
Note that you may rename the folder-links anything you like (e.g. prefixing them with numbers for sorting); all folders in | ||
TODO: configuration instructions
for standalone
Make a dropins folder under site, and link or copy the folders for all the Ferreteria dropins you want to use into that folder.
for MediaWiki
These instructions need to be rewritten. At present, I'm not putting much work into continuing to support MediaWiki.