thomasabishop/eolas-api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update README with further deployment details
All checks were successful
Deploy eolas-api / deploy (push) Successful in 23s
Details

Browse source
This commit is contained in:
Thomas Bishop 2025-10-15 14:49:56 +01:00
parent 9d7610df01
commit f18ad382c7
1 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,6 +1,6 @@
## Deployment ## Deployment
Deployment is automated via Forgejo action (see `.forgejo/workflows/deploy.yml`). Deployment is automated via Forgejo action. See [.forgejo/workflows/deploy.yml](./forgejo/workflows/deploy.yml).
Deployment actions are always executed by the `deploy` user on the VPS. Deployment actions are always executed by the `deploy` user on the VPS.
@ -15,12 +15,18 @@ On pushes to `main`:
- Ignored keywords: `chore`, `test`, `refactor`, and anything else - Ignored keywords: `chore`, `test`, `refactor`, and anything else
- This updates the version in `package.json` and creates Git tag at this version. - This updates the version in `package.json` and creates Git tag at this version.
- Install `rsync` on the `ubuntu-latest` runner, then: - Install `rsync` on the `ubuntu-latest` runner
- Rsync over SSH to copy changed files from this repository to VPS deployment directory, excluding - `rysnc` over SSH to copy changed files from this repository to VPS deployment directory, excluding`.env`.
`.env`
- Restart eolas-api using `systemd` - Restart eolas-api using `systemd`. See `/systemd/eolas-api.service` for copy
of file that runs service on VPS.
### `systemd` service
On the VPS, `eolas-api` runs as a `systemd` service. This service is restarted as part of
the deployment. See copy of this file at
[/systemd/eolas-api.service](./systemd/eolas-api.service).
## API ## API