diff --git a/README.md b/README.md index 6f3211b..4156020 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,23 @@ Mit diesem Server möchte ich ein selbst gehostetes Pendant zu _github pages_ erstellen. Das Ziel ist einen Webserver zu haben auf den ich einfach content deployen kann direkt aus einem gitea repository. + +## Setup + +I assume that you have a server where docker is installed with a running instance of traefik. + +* Create a new directory, e.g.: `/containers/pages` +* Place the docker compose file into this directory +* Change the docker-compose.yml file to your needs and environment. +* get the needed container image: `docker compose pull`. +* spin the container up: `docker compose up -d` + +Check the logs, if everything runs smoothly: +``` +docker compose logs -f +``` + +If you want to stop the container again, use: +``` +docker compose down +```