johanels/akvorado
1
0
Fork 0
mirror of https://github.com/akvorado/akvorado.git synced 2025-12-12 06:24:10 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs: make it even easier to hack on the console

Browse Source 
We add a parameter to disable the healthcheck, making the console
available quickly.
This commit is contained in:
Vincent Bernat
2025-08-31 15:59:41 +02:00
parent e41bae008b
commit 871fc59814
3 changed files with 6 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.env.demo
View File

@@ -6,6 +6,6 @@
COMPOSE_FILE=${COMPOSE_FILE}:docker/docker-compose-tls.yml COMPOSE_FILE=${COMPOSE_FILE}:docker/docker-compose-tls.yml
COMPOSE_PROFILES=demo COMPOSE_PROFILES=demo
BRANDING=true AKVORADO_CFG_CONSOLE_BRANDING=true
TLS_DOMAIN=akvorado.net,www.akvorado.net,demo.akvorado.net TLS_DOMAIN=akvorado.net,www.akvorado.net,demo.akvorado.net
TLS_EMAIL=webmaster@akvorado.net TLS_EMAIL=webmaster@akvorado.net

11
CONTRIBUTING.md
View File

@@ -51,17 +51,10 @@ can spawn them through `docker compose -f docker/docker-compose-dev.yml`:
For manual tests, you can use `make docker-dev` to build a Docker container, For manual tests, you can use `make docker-dev` to build a Docker container,
then use `docker compose --profile demo up` to run Docker Compose. Each time you then use `docker compose --profile demo up` to run Docker Compose. Each time you
modify the code, repeat these two steps. Beware not to destroy the volume for modify the code, repeat these two steps:
GeoIP at each attempt as there is a per-day limit on the number of times one IP
can fetch the GeoIP database.
When using this method, it can take a little bit of time until the console is
declared healthy. In the meantime, you get a 404 error. If you want to avoid
that, you can the console locally instead:
```console ```console
$ docker compose stop akvorado-console $ make docker-dev && CONSOLE_HEALTHCHECK_DISABLED=true docker compose --profile demo up -d
$ make && AKVORADO_CFG_CONSOLE_CLICKHOUSE_SERVERS=$(docker container inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' akvorado-clickhouse-1):9000 AKVORADO_CFG_CONSOLE_SERVELIVEFS=true ./bin/akvorado console /dev/null
``` ```
If you need to work on the frontend part, you can spawn the Docker compose If you need to work on the frontend part, you can spawn the Docker compose

4
docker/docker-compose.yml
View File

@@ -116,7 +116,9 @@ services:
- akvorado-console-db:/run/akvorado - akvorado-console-db:/run/akvorado
environment: environment:
AKVORADO_CFG_CONSOLE_DATABASE_DSN: /run/akvorado/console.sqlite AKVORADO_CFG_CONSOLE_DATABASE_DSN: /run/akvorado/console.sqlite
AKVORADO_CFG_CONSOLE_BRANDING: ${BRANDING-false} AKVORADO_CFG_CONSOLE_BRANDING: ${AKVORADO_CFG_CONSOLE_BRANDING-false}
healthcheck:
disable: ${CONSOLE_HEALTHCHECK_DISABLED-false}
labels: labels:
- traefik.enable=true - traefik.enable=true
# Only expose /debug endpoint on the private entrypoint. # Only expose /debug endpoint on the private entrypoint.