about summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index e69de29..338e4ca 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,22 @@
+# Freitagsfoo! (AAS)
+
+Super basic piece of Software for handling talk submissions.
+
+## Usage
+
+Well, It's pretty straitfowards…
+
+## Setup
+
+1. Adjust the docker-compose.yml how you'd like (you don't need to change
+anything, but could for example add labels so traefik is able to router to
+the container)
+1. Edit the config.yml with the great password you just set for the database
+(You did create a good password didn't you? if not, now's the moment to change
+that!)
+1. Start the `freitagsfoo` and `postgres` service:
+
+```bash
+$ docker-compose up -d freitagsfoo postgres
+…
+```