VbzCart/docs/install: Difference between revisions
imported>Woozle (some updates) |
imported>Woozle (done up to the point of db setup) |
||
Line 2: | Line 2: | ||
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 | * 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}}. | ||
* Copy the <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 | ** We'll call this new location {{arg|local-config}}. | ||
** My standard location for this is <code>/home/vbz/site/config/vbzcart</code> | ** My standard location for this is <code>/home/vbz/site/config/vbzcart</code> | ||
* | * Rename the <code>{{arg|local-config}}/examples</code> folder to <code>{{arg|local-config}}/local</code>. | ||
* 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> | * Optional: modify files in <code>{{arg|local-config}}/portable</code> as needed. | ||
* [[Ferreteria/install|Install Ferreteria]] | * [[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== | ==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: | ||
Definitions | ===Definitions=== | ||
* {{arg|$HOME}} is the home folder of the virtual domain's user account | * {{arg|$HOME}} is the home folder of the virtual domain's user account | ||
** e.g. <code>/home/wvbz/</code> | ** e.g. <code>/home/wvbz/</code> | ||
* {{arg|$USER}} is the system user that Apache will run as | * {{arg|$USER}} is the system user that Apache will run as | ||
** e.g. <code>wvbz</code> | ** e.g. <code>wvbz</code> | ||
* {{arg|$WEB}} is the base folder of files that will be served to the web | |||
Preparation | ** 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=== | |||
Run these commands in a terminal on your web server: | |||
* cd {{arg|$HOME}} | * cd {{arg|$HOME}} | ||
* su {{arg|$USER}} | * su {{arg|$USER}} | ||
Line 29: | Line 32: | ||
* cd git | * cd git | ||
* [[git clone]] git@gitlab.com:woozalia/VbzCart.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'' | ''in progress'' |
Revision as of 13:28, 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:
Definitions
- <$HOME> is the home folder of the virtual domain's user account
- e.g.
/home/wvbz/
- e.g.
- <$USER> is the system user that Apache will run as
- e.g.
wvbz
- e.g.
- <$WEB> is the base folder of files that will be served to the web
- Typically
<$HOME>/public_html
- e.g.
/home/wvbz/public_html
- Typically
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:
- cd <$HOME>
- su <$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 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
.
in progress