diff --git a/README.md b/README.md new file mode 100644 index 0000000..fb0ead0 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# Etebase Docker +Run Etebase Server within Docker Container + +## Setup Instructions +**Docker Run** (not recommended): +```console +$ docker run -d --name "etebase" -v ./data:/opt/etebase-data -p 8080:80 drmaxnix/etebase +``` + +**Docker Compose** (recommended): +```yaml +services: + main: + image: drmaxnix/etebase + restart: unless-stopped + volumes: + - ./data:/opt/etebase-data + ports: + - "8080:80" +``` +```console +$ docker compose up -d +``` + +> ▶️ For both variants, persistent config files and user data will be stored in the `./data` directory. Feel free to change this to your needs. + +> ▶️ With this setup, the server will publicly listen on port 8080 via unencrypted http. When using in production, make sure to use a reverse proxy to add ssl functionality! + +## User Management +Create initial admin account: +```console +$ docker compose exec main .venv/bin/python3 ./manage.py createsuperuser +``` + +> ▶️ If you are using docker run, replace `docker compose exec main` with `docker exec -it etebase`.