Compare commits
3 Commits
main
...
76c0cf3e74
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
76c0cf3e74 | ||
|
|
68689ea885 | ||
| f6293b7a0c |
24
FEATURE_ROADMAP.md
Normal file
24
FEATURE_ROADMAP.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# Goals
|
||||||
|
|
||||||
|
This document contains the wanted feature list and their current state.
|
||||||
|
|
||||||
|
## Basic Pages
|
||||||
|
|
||||||
|
-[] Homepage
|
||||||
|
-[] Boards
|
||||||
|
-[] Committee page
|
||||||
|
-[] Contact page
|
||||||
|
-[] Donator page/Friends of Quatsh
|
||||||
|
-[] Membership page
|
||||||
|
|
||||||
|
## Main Features
|
||||||
|
|
||||||
|
-[] Signup form with email SMTP link.
|
||||||
|
-[] Gallery
|
||||||
|
-[] Login page
|
||||||
|
|
||||||
|
## Extra's
|
||||||
|
|
||||||
|
-[] Allow google-workspace login with SSO?
|
||||||
|
-[] Add Redis for Caching
|
||||||
|
-[] Setup SMTP with automatic switching to in-mem email saving OR print to stdout when in DEBUG mode.
|
||||||
11
README.md
11
README.md
@@ -6,12 +6,18 @@
|
|||||||
|
|
||||||
Running this requires the use of "make" and docker.
|
Running this requires the use of "make" and docker.
|
||||||
|
|
||||||
"make" tends to come pre-installed on linux but not on Windows, to install it on Windows I recommend using Chocolatey as follows: \
|
~"make" tends to come pre-installed on linux but not on Windows, to install it on Windows I recommend using Chocolatey as follows~
|
||||||
|
|
||||||
```
|
```shell
|
||||||
choco install make
|
choco install make
|
||||||
```
|
```
|
||||||
|
|
||||||
|
EDIT: I've swapped over to using [[scoop](https://github.com/ScoopInstaller/Scoop#readme)] for these kinds of installations.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
scoop install make
|
||||||
|
```
|
||||||
|
|
||||||
### Install docker
|
### Install docker
|
||||||
|
|
||||||
<https://docs.docker.com/get-started/get-docker/>
|
<https://docs.docker.com/get-started/get-docker/>
|
||||||
@@ -62,4 +68,3 @@ Or
|
|||||||
```shell
|
```shell
|
||||||
make
|
make
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
31
docs/environment.md
Normal file
31
docs/environment.md
Normal 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
22
docs/installation_faq.md
Normal 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
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user