mirror of
https://github.com/maxdorninger/MediaManager.git
synced 2026-04-19 06:54:54 +02:00
33 lines
1.5 KiB
Markdown
33 lines
1.5 KiB
Markdown
# Installation Guide
|
|
|
|
The recommended way to install and run Media Manager is using Docker and Docker Compose.
|
|
|
|
## Prerequisites
|
|
|
|
* Ensure Docker and Docker Compose are installed on your system.
|
|
* If you plan to use OAuth 2.0 / OpenID Connect for authentication, you will need an account and client credentials
|
|
from an OpenID provider (e.g., Authentik, Pocket ID).
|
|
|
|
## Setup
|
|
|
|
* Download the `docker-compose.yaml` from the MediaManager repo with the following command:
|
|
```bash
|
|
wget -O docker-compose.yaml https://raw.githubusercontent.com/maxdorninger/MediaManager/refs/heads/master/docker-compose.yaml
|
|
mkdir config
|
|
wget -O ./config/config.toml https://raw.githubusercontent.com/maxdorninger/MediaManager/refs/heads/master/config.example.toml
|
|
# you probably need to edit the config.toml file in the ./config directory, for more help see the documentation
|
|
docker compose up -d
|
|
```
|
|
|
|
* Upon first run, MediaManager will create a default `config.toml` file in the `./config` directory.
|
|
|
|
* You can edit this file to configure MediaManager according to your needs.
|
|
|
|
* Upon first run, MediaManager will also create a default admin user with the email, it's recommended to change the
|
|
password of this user after the first login. The credentials of the default admin user will be printed in the logs of
|
|
the container.
|
|
|
|
* For more information on the available configuration options, see the [Configuration section](Configuration.md) of the
|
|
documentation.
|
|
|
|
<include from="notes.topic" element-id="auth-admin-emails"></include> |