VbzCart/docs/install: Difference between revisions

From Woozle Writes Code
< VbzCart‎ | docs
Jump to navigation Jump to search
imported>Woozle
No edit summary
imported>Woozle
(finished? mostly?)
Line 12: Line 12:
* Set up database and tables (instructions to be written)
* Set up database and tables (instructions to be written)
==Woozle's setup==
==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:
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):
===Definitions===
* {{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===
===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.
Line 26: Line 18:
'''1.''' [[Ferreteria/install|Install Ferreteria]] (you can actually do this at any point, but it may be easier to do it first).
'''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:
'''2.''' Run these commands in a terminal on your web server (you can skip <code>[[mkdir]]</code> wherever the folder already exists):
* cd {{arg|$HOME}}
* cd {{arg|$HOME}}
* su {{arg|$USER}}
* su {{arg|$USER}}
Line 32: Line 24:
* cd site
* cd site
* mkdir git
* mkdir git
* cd git
* [[git clone]] git@gitlab.com:woozalia/VbzCart.git
* [[git clone]] git@gitlab.com:woozalia/VbzCart.git
* cd ..
* cd ..
Line 43: Line 34:
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>.
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''
At this point, I ''think'' you should be able to point a browser at the domain and get something, even if it's only errors that you'll need to look at in order to figure out what's left to configure.

Revision as of 22:52, 10 October 2019

Prerequisites: Linux, PHP 7, MySQL-workalike, Apache.

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)

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

1. 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 (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/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 vbzcart/local as needed to match your local environment. (If you use the same structure I'm using here, index.php will not need modification.) This will require having a database set up so you can get the appropriate connection credentials to put in creds.php.

At this point, I think you should be able to point a browser at the domain and get something, even if it's only errors that you'll need to look at in order to figure out what's left to configure.