update documentation of the config file

This commit is contained in:
maxDorninger
2025-07-18 14:00:23 +02:00
parent c529f6f273
commit eacdd5b74f
3 changed files with 8 additions and 10 deletions

View File

@@ -31,8 +31,7 @@ other services.
```sh
wget -O docker-compose.yaml https://raw.githubusercontent.com/maxdorninger/MediaManager/refs/heads/master/docker-compose.yaml
wget -O config.toml https://raw.githubusercontent.com/maxdorninger/MediaManager/refs/heads/master/config.toml
# you probably need to edit the config.toml file, for more help see the documentation
# you probably need to edit the config.toml file in the ./config directory, for more help see the documentation
docker compose up -d
```

View File

@@ -7,15 +7,15 @@ Frontend settings are configured through environment variables in your `docker-c
## Configuration File Location
Your `config.toml` file should be mounted to `/app/config.toml` inside the container:
Your `config.toml` file should be in the directory that's mounted to `/app/config/config.toml` inside the container:
```yaml
volumes:
- ./config.toml:/app/config.toml
- ./config:/app/config
```
Though you can change the location of the configuration file by setting the `CONFIG_FILE` env variable to another path,
e.g. `/etc/mm/config.toml`.
Though you can change the location of the configuration file's directory by setting the `CONFIG_DIR` env variable to another path,
e.g. `/etc/mediamanager/`.
## Configuration Sections

View File

@@ -10,11 +10,10 @@ The recommended way to install and run Media Manager is using Docker and Docker
## Setup
* Download the `docker-compose.yaml` and `config.toml` from the MediaManager repo with the following command:
* Download the `docker-compose.yaml` from the MediaManager repo with the following command:
```sh
wget -O docker-compose.yaml https://raw.githubusercontent.com/maxdorninger/MediaManager/refs/heads/master/docker-compose.yaml
wget -O config.toml https://raw.githubusercontent.com/maxdorninger/MediaManager/refs/heads/master/config.toml
# you probably need to edit the config.toml file, for more help see the documentation
wget -O docker-compose.yaml https://raw.githubusercontent.com/maxdorninger/MediaManager/refs/heads/master/docker-compose.yaml
# you probably need to edit the config.toml file in the ./config directory, for more help see the documentation
docker compose up -d
```