diff options
| -rw-r--r-- | README.md | 38 |
1 files changed, 28 insertions, 10 deletions
diff --git a/README.md b/README.md index 493c630..47b6728 100644 --- a/README.md +++ b/README.md @@ -7,31 +7,49 @@ docker-compose that can be used to start a circus (note: a digital one...) Execute the `setup.sh` file, it will ask you to configure some stuff. You can also setup the circus manually, read on for more infos: +### Docker networking -### Networking +Create some docker networks: ``` -$ docket network create circus -$ docket network create circus_db +$ docker network create circus +$ docker network create circus_db ``` -Set the `HOSTNAME` environment variable in the `.env` file to the host you want to host the ctf -on, for example: +These will contain the various services and make sure some services can and some +services can't communiate with each other. + +### Gerneral configuration + +First of all, you should define where the CTF should run and what it should be +called. To do so, fill the `.env` file with the corresponding information: ``` HOSTNAME=docker.localhost +CTFNAME=MyCTF ``` -### Grafana +### Service configuration + +#### Traefik + +Traefik requires the credentials as a `user:pass` combination, the password is +hashed. + +To create a traefik basicauth user, execute `$ htpasswd -nb user password` with +your username and password and append the result to the `traefik_users` file. + +#### Grafana + +Define the grafana location in the `grafana.env` file. -Define Grafana foo in `grafana.env`: ``` GF_SERVER_ROOT_URL=http://grafana.docker.localhost:3000 GF_SECURITY_ADMIN_PASSWORD=secret ``` -When setting up Grafana, you can create a Prometheus data source using -prometheus located at `http://prometheus:9090`. +- When starting grafana, you can login as `admin:secret` +- You can create a prometheus datasource using the URL `http://prometheus:9090` ### Opening the circus @@ -45,6 +63,6 @@ Services: - [http://traefik.docker.localhost](http://traefik.docker.localhost) - [http://register.docker.localhost](http://register.docker.localhost) - [http://manager.docker.localhost](http://manager.docker.localhost) -- [http://scoreboard.docker.localhost/metrics](http://scoreboard.docker.localhost/metrics) +- [http://scoreboard.docker.localhost](http://scoreboard.docker.localhost) - [http://prometheus.docker.localhost](http://prometheus.docker.localhost) - [http://grafana.docker.localhost](http://grafana.docker.localhost) |
