Ferreteria/install

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/.
• Copy the <ferreteria base>/config folder 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
• 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.

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_html or www) inside <$HOME>
• <$ft> = the Ferreteria base folder (My convention: <$HOME>/site/git/ferreteria)

See wooz: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 <$HOME>/site/dropins will be checked for valid drop-ins.

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

Where $kfpSiteRoot is the server user's folder, and ferreteria's repo is in $kfpSiteRoot/git/ferreteria/: Template:Fmt/php