VbzCart/docs/install: Difference between revisions

From Woozle Writes Code
< VbzCart‎ | docs
Jump to navigation Jump to search
imported>Woozle
No edit summary
m (Woozle moved page VbzCart/VbzCart/install to VbzCart/docs/install without leaving a redirect: correct naming (was no way to import directly to this name))
 
(11 intermediate revisions by one other user not shown)
Line 1: Line 1:
'''Prerequisites''': Linux, [[PHP]] 7, [[MySQL]]-workalike, [[Apache web server|Apache]].
===Preparation===
* '''Prerequisites''': Linux, [[PHP]] 7.4+, [[MySQL]]-workalike, [[Apache web server|Apache]].
* 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.


This page will eventually need to include a lot more information, but for now the basic setup procedure is:
This page will eventually need to include a lot more information, but for now the basic setup procedure is:
* Clone the VbzCart Git repository at <code>[git@gitlab.com:woozalia/VbzCart.git</code> into a folder of your choice, which we'll call {{arg|vbz-base}}.
* Clone the VbzCart Git repository at <code>{{i/var/page|git.origin}}</code> into a folder of your choice, which we'll call {{arg|vbz-base}}.
* Copy the <code>{{arg|vbz-base}}/config</code> folder to a location outside of <code>{{arg|vbz-base}}</code>.
* Copy the <code>{{arg|vbz-base}}/config</code> folder to a location outside of <code>{{arg|vbz-base}}</code>.
** We'll call this new location {{arg|local-config}}.
** We'll call this new location {{arg|local-config}}.
Line 9: Line 11:
* Modify each file to match your local environment, according to instructions in each file.
* Modify each file to match your local environment, according to instructions in each file.
* Optional: modify files in <code>{{arg|local-config}}/portable</code> as needed.
* Optional: modify files in <code>{{arg|local-config}}/portable</code> as needed.
* [[Ferreteria/install|Install Ferreteria]]
* {{l/ferreteria/|install|Install Ferreteria}}
* Set up database and tables (instructions to be written)
* Set up database and tables (instructions to be written)
==Woozle's setup==
* Link or copy the <code>{{arg|local-config}}/portable/index.php</code> file to your public web folder.
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:
* Link or copy the <code>{{arg|vbz-base}}/static</code> folder to your public web folder.
===Definitions===
* Create the public web ufiles folder
* {{arg|$HOME}} is the home folder of the virtual domain's user account
** e.g. <code>/home/wvbz/</code>
* {{arg|$USER}} is the system user that Apache will run as
** e.g. <code>wvbz</code>
* {{arg|$WEB}} is the base folder of files that will be served to the web
** Typically <code>{{arg|$HOME}}/public_html</code>
** e.g. <code>/home/wvbz/public_html</code>
===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.
===Steps===
'''1.''' [[Ferreteria/install|Install Ferreteria]] (you can actually do this at any point, but it may be easier to do it first).
 
'''2.''' Run these commands in a terminal on your web server:
* cd {{arg|$HOME}}
* su {{arg|$USER}}
* [[mkdir]] site
* cd site
* mkdir git
* cd git
* [[git clone]] git@gitlab.com:woozalia/VbzCart.git
* cd ..
* mkdir config
* cd config
* cp -R ../git/VbzCart/config vbzcart
* mv vbzcart/examples vbzcart/local
* ln -rs vbzcart/local/index.php ~/public_html/index.php
 
Modify the files in <code>vbzcart/local</code> as needed to match your local environment. (If you use the same structure I'm using here, <code>index.php</code> will not need modification.) This will require having a database set up so you can get the appropriate connection credentials to put in <code>creds.php</code>.


''in progress''
For the canonical setup at vbz.net, see {{l/wooz|VbzCart/setup|wooz.dev}}.

Latest revision as of 01:53, 25 February 2024

Preparation

  • Prerequisites: Linux, PHP 7.4+, MySQL-workalike, Apache.
  • 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.

This page will eventually need to include a lot more information, but for now the basic setup procedure is:

  • Clone the VbzCart Git repository at git@gitlab.com:woozalia/VbzCart.git into a folder of your choice, which we'll call <vbz-base>.
  • Copy the <vbz-base>/config folder to a location outside of <vbz-base>.
    • We'll call this new location <local-config>.
    • My standard location for this is /home/vbz/site/config/vbzcart
  • Rename the <local-config>/examples folder to <local-config>/local.
  • Modify each file to match your local environment, according to instructions in each file.
  • Optional: modify files in <local-config>/portable as needed.
  • Install Ferreteria
  • Set up database and tables (instructions to be written)
  • Link or copy the <local-config>/portable/index.php file to your public web folder.
  • Link or copy the <vbz-base>/static folder to your public web folder.
  • Create the public web ufiles folder

For the canonical setup at vbz.net, see Template:L/wooz.