Docker Documentation

docs/setup/server/docker.md

@@ -0,0 +1,48 @@
+# Docker
+
+## dev environment
+
+This clones the master branch into a docker builder and runs a build before starting it.
+To run it you need docker and docker-compose
+`sudo docker compose up` or `sudo docker compose up -d`
+
+## prod environment with local file storage
+
+Set the following environment variables in your environment (adapt POSTGRES_USER, POSTGRES_PASSWORD):
+
+`export POSTGRES_USER=postgres` <br />
+`export POSTGRES_PASSWORD=postgres` <br />
+`export POSTGRES_DATABASE=fosscord`
+
+This clones the master branch into a docker builder and runs a build before starting it.
+To run it you need docker and docker-compose
+`sudo docker-compose -f docker-compose.prod.yaml up` or `sudo docker-compose -f docker-compose.prod.yaml up -d`
+
+At first start, you get an
+
+```
+db_1        | 2023-03-04 17:28:25.790 UTC [63] ERROR:  relation "config" does not exist at character 31
+db_1        | 2023-03-04 17:28:25.790 UTC [63] STATEMENT:  SELECT COUNT(1) AS "cnt" FROM "config" "ConfigEntity"
+```
+
+## prod environment with S3 file storage
+
+Set the following environment variables in your environment (adapt POSTGRES_USER, POSTGRES_PASSWORD, S3_BUCKET, S3_BUCKET_NAME,S3_BUCKET_REGION):
+
+`export POSTGRES_USER=postgres` <br />
+`export POSTGRES_PASSWORD=postgres` <br />
+`export POSTGRES_DATABASE=fosscord` <br />
+`export S3_BUCKET=S3://...` <br />
+`export S3_BUCKET_NAME=test` <br />
+`export S3_BUCKET_REGION=eu-central-1`
+
+This clones the master branch into a docker builder and runs a build before starting it.
+To run it you need docker and docker-compose
+`docker-compose -f docker-compose.prod.s3.yaml up` or `docker-compose -f docker-compose.prod.s3.yaml up -d`
+
+At first start, you get an
+
+```
+db_1        | 2023-03-04 17:28:25.790 UTC [63] ERROR:  relation "config" does not exist at character 31
+db_1        | 2023-03-04 17:28:25.790 UTC [63] STATEMENT:  SELECT COUNT(1) AS "cnt" FROM "config" "ConfigEntity"
+```

docs/setup/server/index.md

@@ -47,6 +47,12 @@ If all went according to plan, you can now access your new Fosscord instance at
 If you set up your server remotely, you can use `curl http://localhost:3001/api/ping` to verify the server is up and running,
 (you should set up a reverse proxy, next!).
 
+## Docker
+
+To use docker please read the following page:
+
+-   [Docker](docker.md)
+
 ## Now what?
 
 Well, now you can configure Fosscord to your liking!