From f2580675a0a3ccc6cb9f2364404412ea3af2841f Mon Sep 17 00:00:00 2001 From: Tobias Brunner Date: Fri, 21 Mar 2025 14:05:33 +0100 Subject: [PATCH] document deployment to staging --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9af34d2..18a5d6f 100644 --- a/README.md +++ b/README.md @@ -35,9 +35,10 @@ uv run src/manage.py runserver This will start the development server on http://localhost:8000. -### Configuration +## Configuration -TODO +Configuration happens using environment variables. +See the available parameters in `.env.example`. ## Code style and linting @@ -69,13 +70,18 @@ Running: ```bash docker run --rm -ti -p 8080:8080 --name=servala-portal --rm --env-file .env local/servala-portal +docker exec -it servala-portal uv run src/manage.py createsuperuser ``` -TODO: Persistence +Then access it with http://localhost:8080/ and the Django admin with http://localhost:8080/admin ## Deployment -TODO +The code is automatically built and deployed on a push to the main branch. +See `.forgejo/workflows/build-deploy-staging.yaml` for the actual workflow. + +Deployment files are in the `deployment/kustomize` folder and makes use of [Kustomize](https://kustomize.io/) to account for differences between the deployment stages. +Stages are configured with overlays in `deployment/kustomize/overlays/$environment`. ## Testing