Ferreteria/v0.6/install

Summary

• Wherever your Ferreteria work is going to be, I'll refer to that as <FeLocal>.
• Inside <FeLocal>, clone the Ferreteria Git repository. This will create <FeLocal>/ferreteria, which I'll call <FeGit>.
  • For web deployments, my standard location Conventions/vdomain for this is /home/<user>/site/git/ferreteria/.
  • (For CLI usage on a shared server, I don't have a standard yet. For usage on your own machine, it's totally up to you; all the included symlinks should be relative.)
• Make a "config" folder outside of the repository. I'll call this <FeConf>.
  • For web deployments, my standard location for this is /home/<user>/site/config/ferreteria/
  • On my own system, I use: <FeLocal>/@config

Ferreteria as a whole currently has no configs, so the configuration details depend on the application (subfolders of <FeGit>/apps).

For the futilities, it goes like this (TODO: move this to the futilities docs):

• The futilities configs go inside <FeConf>/futils/ (I'll call this folder <FuConf>).
• Inside the <FuConf> folder:
  • Create a link from <FuConf>/active/ to your actual local config files.
    • These can either be in the repository or outside of it.
    • Configs kept inside the repository should go inside <FuGit>/apps/futils/config/ready/.
    • I am currently using the scooter/ subfolder -- aka <FuGit>/apps/futils/config/ready/scooter/.

That folder contains both general conf files for the futilities as well as specific conf files for each futile runnable. Only the runnable-config folders are scanned, but they can link (preferably with relative symlinks) to configs in the general/outer futilities config folder.

(The instructions at Ferreteria/v0.5/install, while no longer accurate, may have pieces in them that will be helpful for writing more of this later -- especially the web deployment details.)