mirror of
https://github.com/thomiceli/opengist.git
synced 2024-12-23 13:02:39 +00:00
6d31ef9732
* Add vitepress for docs * some fix * Use vitepress and update docs * Use vitepress and update docs * Update README.md * Add favicon * Add docs by @jiriks74 Co-authored-by: jiriks74 <jiri@stefka.eu> --------- Co-authored-by: jiriks74 <jiri@stefka.eu>
48 lines
1.1 KiB
Markdown
48 lines
1.1 KiB
Markdown
# Configuration
|
|
|
|
Opengist provides flexible configuration options through either a YAML file and/or environment variables.
|
|
You would only need to specify the configuration options you want to change — for any config option left untouched,
|
|
Opengist will simply apply the default values.
|
|
|
|
The [configuration cheat sheet](cheat-sheet.md) lists all available configuration options.
|
|
|
|
|
|
## Configuration via YAML file
|
|
|
|
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
|
|
```
|
|
|
|
You can start by copying and/or modifying the provided [config.yml](https://github.com/thomiceli/opengist/blob/stable/config.yml) file.
|
|
|
|
|
|
## Configuration via Environment Variables
|
|
|
|
Usage with Docker Compose :
|
|
```yml
|
|
services:
|
|
opengist:
|
|
# ...
|
|
environment:
|
|
OG_LOG_LEVEL: "info"
|
|
# etc.
|
|
```
|
|
|
|
Usage via command line :
|
|
```shell
|
|
OG_LOG_LEVEL=info ./opengist
|
|
```
|