Difference between revisions of "Ferreteria/install"

from HTYP, the free directory anyone can edit if they can prove to me that they're not a spambot
Jump to navigation Jump to search
Line 1: Line 1:
 
* 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 [[User:Woozle/setups/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>.
Line 21: Line 22:
 
* cd config
 
* cd config
 
* cp -R ../git/ferreteria/config ferreteria
 
* cp -R ../git/ferreteria/config ferreteria
 
+
===for standalone===
 
Make a <code>dropins</code> folder under <code>site</code>, and link or copy the folders for all the Ferreteria dropins you want to use into that folder.
 
Make a <code>dropins</code> folder under <code>site</code>, and link or copy the folders for all the Ferreteria dropins you want to use into that folder.
 +
===for MediaWiki===
 +
Where <code>$kfpSiteRoot</code> is the server user's folder, and ferreteria's repo is in <code>$kfpSiteRoot/git/ferreteria/</code>:
 +
<source lang=php>require_once($kfpSiteRoot.'/site/git/ferreteria/start.php');
 +
ferreteria\classloader\cLoader::LoadLibrary('ferreteria.mw.core');
 +
</source>

Revision as of 00:39, 23 September 2020

  • Clone the Ferreteria Git repository into a folder of your choice, which we'll call {[arg|ferreteria base}}.
  • 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.

Woozle's setup

Some specifics of how I usually set things up these days, giving examples from the dev instance I'm setting up as I type this (see User:Woozle/setups/vdomain for definitions):

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

Run these commands in a terminal on your web server (you can skip mkdir wherever the folder already exists):

  • cd <$HOME>
  • su <$USER>
  • mkdir site
  • cd site
  • mkdir git
  • git clone git@gitlab.com:woozalia/ferreteria.git
  • cd ..
  • mkdir config
  • cd config
  • cp -R ../git/ferreteria/config ferreteria

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/:

require_once($kfpSiteRoot.'/site/git/ferreteria/start.php');
ferreteria\classloader\cLoader::LoadLibrary('ferreteria.mw.core');