document deployment to staging
This commit is contained in:
parent
07812efe82
commit
f2580675a0
1 changed files with 10 additions and 4 deletions
14
README.md
14
README.md
|
@ -35,9 +35,10 @@ uv run src/manage.py runserver
|
||||||
|
|
||||||
This will start the development server on http://localhost:8000.
|
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
|
## Code style and linting
|
||||||
|
|
||||||
|
@ -69,13 +70,18 @@ Running:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker run --rm -ti -p 8080:8080 --name=servala-portal --rm --env-file .env local/servala-portal
|
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
|
## 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
|
## Testing
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue