config.yml with Docker (#131)

This commit is contained in:
Thomas Miceli 2023-10-15 15:14:34 +09:00 committed by GitHub
parent b1acea9f1c
commit ef45f3d0ca
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 18 additions and 3 deletions

View file

@ -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 .

View file

@ -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+)

View file

@ -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"

View file

@ -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
```