From ef45f3d0cac76b55ec1df85208169a0baf302dd0 Mon Sep 17 00:00:00 2001 From: Thomas Miceli <27960254+thomiceli@users.noreply.github.com> Date: Sun, 15 Oct 2023 15:14:34 +0900 Subject: [PATCH] config.yml with Docker (#131) --- Dockerfile | 2 ++ README.md | 2 ++ docker/entrypoint.sh | 3 ++- docs/configuration/index.md | 14 ++++++++++++-- 4 files changed, 18 insertions(+), 3 deletions(-) diff --git a/Dockerfile b/Dockerfile index c5a0836..c340523 100644 --- a/Dockerfile +++ b/Dockerfile @@ -40,6 +40,8 @@ RUN apk update && \ RUN addgroup -S opengist && \ adduser -S -G opengist -H -s /bin/ash -g 'Opengist User' opengist +COPY --from=build --chown=opengist:opengist /opengist/config.yml config.yml + WORKDIR /app/opengist COPY --from=build --chown=opengist:opengist /opengist/opengist . diff --git a/README.md b/README.md index 413fa55..15ef5f6 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,8 @@ chmod +x opengist ./opengist # with or without `--config config.yml` ``` +Opengist is now running on port 6157, you can browse http://localhost:6157 + ### From source Requirements : [Git](https://git-scm.com/downloads) (2.20+), [Go](https://go.dev/doc/install) (1.20+), [Node.js](https://nodejs.org/en/download/) (16+) diff --git a/docker/entrypoint.sh b/docker/entrypoint.sh index 68a2080..339d02d 100755 --- a/docker/entrypoint.sh +++ b/docker/entrypoint.sh @@ -7,5 +7,6 @@ groupmod -o -g "$GID" $USER usermod -o -u "$UID" $USER chown -R "$USER:$USER" /opengist +chown -R "$USER:$USER" /config.yml -exec su $USER -c "OG_OPENGIST_HOME=/opengist /app/opengist/opengist" +exec su $USER -c "OG_OPENGIST_HOME=/opengist /app/opengist/opengist --config /config.yml" diff --git a/docs/configuration/index.md b/docs/configuration/index.md index 1327aa4..3283e27 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -12,6 +12,17 @@ The [configuration cheat sheet](cheat-sheet.md) lists all available configuratio The configuration file must be specified when launching the application, using the `--config` flag followed by the path to your YAML file. +Usage with Docker Compose : +```yml +services: + opengist: + # ... + volumes: + # ... + - "/path/to/config.yml:/config.yml" +``` + +Usage via command line : ```shell ./opengist --config /path/to/config.yml ``` @@ -22,7 +33,6 @@ You can start by copying and/or modifying the provided [config.yml](/config.yml) ## Configuration via Environment Variables Usage with Docker Compose : - ```yml services: opengist: @@ -31,8 +41,8 @@ services: OG_LOG_LEVEL: "info" # etc. ``` -Usage via command line : +Usage via command line : ```shell OG_LOG_LEVEL=info ./opengist ```