Updated readme, started extra documentation, started feature list/plan.

This commit is contained in:
WGAVermeer
2026-03-28 12:30:57 +01:00
parent 49199b7184
commit 68689ea885
4 changed files with 85 additions and 3 deletions

31
docs/environment.md Normal file
View File

@@ -0,0 +1,31 @@
# Details on environment variables
## Nginx
### NGINX_HOSTNAME
## Django
### DEBUG
### DJANGO_SETTINGS_MODULE
### DJANGO_SECRET_KEY
## Database (PostgreSQL)
### POSTGRES_HOST
### POSTGRES_PORT
### POSTGRES_USER
### POSTGRES_PASSWORD
### POSTGRES_DBNAME
## Gunicorn
### GUNICORN_WORKERS
### GUNICORN_TIMEOUT

22
docs/installation_faq.md Normal file
View File

@@ -0,0 +1,22 @@
# Common Issues & Questions
## Environment
### Postgres Database
The database login-details are set upon first-launch.
Therefore trying to change them later, after first-launch, will require a change of these details.
A way of sidestepping manually changing this in the DB-shell is by deleting the postgres data volume.
> [!WARNING]
> Do not run this command in prod, it will delete ALL data in our database.
```shell
docker volume rm quatsh-website_postgres-data
```
After running this command a Django Migration has to be run to remake the tables.
``` shell
docker exec quatsh-website-web-1 python manage.py migrate
```