Skip to content

Latest commit

 

History

History
184 lines (136 loc) · 4.62 KB

README.md

File metadata and controls

184 lines (136 loc) · 4.62 KB
Raw

Deployment

This document describes how to prepare a host to deploy from a specific branch and optionally to update when a push happens to that branch.

All instructions are for an Alpine 3.18 and require adjustment if a different system is used.

Update the system

apk update
apk upgrade

Install Software

Install nginx

apk add nginx
rc-update add nginx boot
service nginx start

Install node & npm

apk add nodejs npm

Install pm2

npm install pm2 -g
pm2 startup
rc-update add pm2 boot

Install git

apk add git

Install mariadb

apk add mysql mysql-client
service mariadb setup
rc-update add mariadb boot
# allow access from network
vi /etc/my.cnf.d/mariadb-server.cnf
# comment out `skip-networking`
# add `bind-address = localhost`
service mariadb start

Install the project

Clone the repository

cd /var/www/localhost/htdocs/
git clone https://github.com/dreammall-earth/dreammall.earth.git
cd dreammall.earth

Configure nginx

# replace nginx config
cp -f deployment/nginx/default.conf /etc/nginx/http.d/default.conf
# adjust the nginx config accordingly
vi /etc/nginx/http.d/default.conf
# frontend nginx config
cp deployment/nginx/frontend.conf /etc/nginx/http.d/frontend.conf
# adjust the frontend nginx config accordingly
vi /etc/nginx/http.d/frontend.conf
# note: replace log paths according to your installation directory
service nginx restart

Create Database User

mysql

Create Database Tea

CREATE USER 'dreammall'@'localhost' IDENTIFIED BY 'SECRET';
GRANT ALL PRIVILEGES ON * . * TO 'dreammall'@'localhost';
FLUSH PRIVILEGES;
exit

Configure database connection

cp backend/.env.dist backend/.env
# adjust the .env config as needed
vi backend/.env
# DATABASE_URL="mysql://dreammall:SECRET@localhost:3306/dreammall.earth"

Configure backend connections

Presenter

cp presenter/.env.dist presenter/.env
# adjust the .env config as needed
vi presenter/.env
# PUBLIC_ENV__ENDPOINTS__GRAPHQL_URI=http://localhost/api

Frontend

cp frontend/.env.dist frontend/.env
# adjust the .env config as needed
vi frontend/.env

Deploy the project

To deploy the project run

deployment/deploy.sh

This will build all projects parts and start a pm2 instance to serve the corresponding services currently defined in the nginx config found in deployment/nginx/default.conf.

Those services are

Service URL
presenter https://host/
backend https://host/api
docs https://host/docs
webhooks (optional) https://host/hooks/

(Optional) Webhook to auto update

To enable autoupdate from a github branch do the following:

Install webhook

apk add webhook

Configure webhook

cp deployment/webhooks/hooks.json.template deployment/webhooks/hooks.json
vi deployment/webhooks/hooks.json
# adjust content of .github/webhooks/hooks.json
# replace all variables accordingly

# copy webhook service file
cp deployment/init.d/webhook.template /etc/init.d/webhook
vi /etc/init.d/webhook
# adjust content of /etc/init.d/webhook
chmod +x /etc/init.d/webhook

# start the webhook service
rc-update add webhook boot
service webhook start

In github configure a webhook pointing to the correct url with the following setting:

Field Value
Payload URL https://host/hooks/github
Content type application/json
Secret A SECRET
SSL verification Enable SSL verification
Which events would you like to trigger this webhook? Send me everything.
Active [x]

Remark: Be aware that you need to restart webhook if you change the configuration in hooks.json e.g. when changing the branch to listen to.