Skip to content

Commit b2833bf

Browse files
committed
add more info on deployment section on readme
1 parent 2cab39a commit b2833bf

File tree

1 file changed

+30
-6
lines changed

1 file changed

+30
-6
lines changed

README.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -176,14 +176,18 @@ make lint
176176

177177
## Deployment
178178

179-
See [Deployment](./docs/deployment.md) for more details.
179+
See the [Deployment](./docs/deployment.md) document for an overview on steps
180+
required to deploy a mataroa instance.
180181

181-
Deployment is configured using [uWSGI](https://uwsgi.readthedocs.io/en/latest/)
182-
and [Caddy](https://caddyserver.com/).
182+
See the [Server Playbook](./docs/server-playbook.md) document for a detailed
183+
run through of setting up a mataroa instance on an Ubuntu 22.04 LTS system
184+
using [uWSGI](https://uwsgi.readthedocs.io/en/latest/) and
185+
[Caddy](https://caddyserver.com/).
183186

184-
Environment variables for production are defined both in `uwsgi.ini` (for uWSGI)
185-
and in `.envrc` (for manage.py commands such as migrations and cron management
186-
commands).
187+
See the [Server Migration](./docs/server-migration.md) document for a guide on
188+
how to migrate servers.
189+
190+
### Useful Commands
187191

188192
To reload the uWSGI process:
189193

@@ -196,6 +200,26 @@ To reload Caddy:
196200
```sh
197201
systemctl restart caddy # root only
198202
```
203+
204+
uWSGI logs:
205+
206+
```sh
207+
journalctl -fb -u mataroa.uwsgi
208+
```
209+
210+
Caddy logs:
211+
212+
```sh
213+
journalctl -fb -u caddy
214+
```
215+
216+
Get an overview with systemd status:
217+
218+
```sh
219+
systemctl status caddy
220+
systemctl status mataroa.uwsgi
221+
```
222+
199223
## Backup
200224

201225
See [Database Backup](docs/database-backup.md) for details. In summary:

0 commit comments

Comments
 (0)