spt/Website
spt/Website
2
2
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: Update documentation

Browse Source
This commit is contained in:
Mangiang 2021-10-29 18:37:01 -04:00
parent 568e90e194
commit 97e4ee0293
No known key found for this signature in database
GPG Key ID: DAE9B92A692CD55C
1 changed files with 24 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
items/README.md
View File

@ -1,28 +1,40 @@
# SPT Items # SPT Items
## Notes
* This project assumes that the target OS is ubuntu
* This project has been tested on Ubuntu 20.04
* This project assumes that nginx is already installed on the target machine
* You can use either of the two drone pipeline types: * You can use either of the two drone pipeline types:
* [docker](../.drone-docker.yml) * [docker](../.drone-docker.yml)
* [kubernetes](../.drone-kubernetes.yml) * [kubernetes](../.drone-kubernetes.yml)
* Some enhancement ideas can be found [here](#some-enhancement-ideas) * Some enhancement ideas can be found [here](#some-enhancement-ideas)
## Required secrets
| secret name | description | example |
| :----------------- | :---------- | :------- |
| spt_items_hostname | The remote server where spt-items-finder will be reachable <br> used for the frontend resolution | spt-items.my.server.com |
| deploy_path | The path to deploy to in the remote machine | `/var/www/html/aki/Website/items` |
| deploy_hostname | The remote server where to deploy <br> used by Ansible SSH | my.server.com |
| deploy_username | The default username to use on the remote server <br> used by Ansible SSH | www-data |
| deploy_user_group | The default user group to use on the remote server <br> used to set permission on the website folder | www-data |
| deploy_ssh_key | The **content** of the ssh private key used to connect to the remote server <br> The key needs to be in RSA in "RSA PRIVATE KEY" format <br> The ssh publick key needs to already be in the user used in the remote server ~/.ssh/authorized_keys | -----BEGIN RSA PRIVATE KEY----- <br> The key <br> -----END RSA PRIVATE KEY----- |
## ⚠ Important notes for the deployment ⚠
* Add all required secrets in Drone
* Server permissions:
1. The server must be able to use `apt` package manager
1. The *deploy_usernam* must exists, be part of the group *deploy_user_group* and be able to SSH into the server
1. If the parent folder of *deploy_path* already exists, *deploy_username* must have read and write permissions on it
* PHP:
1. `php8.0-fpm` and all its dependencies must already be installed
1. `php8.0-fpm` must be configured to use *deploy_username* (to ensure the cache created by Laravel can be deleted before every new deployment)
* Nginx:
1. Nginx must be using uses the user group *deploy_user_group*
1. Nginx must be configured to use HTTPS
1. Nginx must be configured to listen to *spt_items_hostname* and to point to the *deploy_path*
## The pipeline summary ## The pipeline summary
1. Each push will: 1. Each push will:
1. Builds the frontend 1. Builds the frontend
1. Move the build frontend in the backend `public` folder 1. Move the build frontend in the backend `public` folder
1. IF Promoted to production, deploys to the server 1. IF Promoted to production, deploys to the server
## Required secrets
| secret name | description | example |
| :-----------------| :---------- | :------- |
| spt_items_hostname | The remote server where spt-items-finder will be reachable <br> used for the frontend resolution | spt-items.my.server.com |
| deploy_hostname | The remote server where to deploy <br> used by Ansible SSH | my.server.com |
| deploy_username | The default username on the remote server <br> used by Ansible SSH <br> This user must have sudo rights | myuser |
| deploy_ssh_key | The **content** of the ssh private key used to connect to the remote server <br> The key needs to be in RSA in "RSA PRIVATE KEY" format <br> The ssh publick key needs to already be in the user used in the remote server ~/.ssh/authorized_keys | -----BEGIN RSA PRIVATE KEY----- <br> The key <br> -----END RSA PRIVATE KEY----- |
## The pipeline walkthrough ## The pipeline walkthrough
see [Walkthrough.md](./docs/Walkthrough.md) see [Walkthrough.md](./docs/Walkthrough.md)