convert gitbook files to mkdocs

This commit is contained in:
maxid
2026-02-08 18:43:00 +01:00
parent 2665106847
commit 9c94ef6de0
54 changed files with 391 additions and 423 deletions

View File

@@ -9,8 +9,8 @@
Follow these steps to get MediaManager running with Docker Compose:
{% stepper %}
{% step %}
#### Get the docker-compose file
Download the `docker-compose.yaml` from the MediaManager repo:
@@ -18,9 +18,9 @@ Download the `docker-compose.yaml` from the MediaManager repo:
```bash
wget -O docker-compose.yaml https://github.com/maxdorninger/MediaManager/releases/latest/download/docker-compose.yaml
```
{% endstep %}
{% step %}
#### Prepare configuration directory and example config
Create a config directory and download the example configuration:
@@ -29,15 +29,15 @@ Create a config directory and download the example configuration:
mkdir config
wget -O ./config/config.toml https://github.com/maxdorninger/MediaManager/releases/latest/download/config.example.toml
```
{% endstep %}
{% step %}
#### Edit configuration
You probably need to edit the `config.toml` file in the `./config` directory to suit your environment and preferences. [How to configure MediaManager.](configuration/)
{% endstep %}
You probably need to edit the `config.toml` file in the `./config` directory to suit your environment and preferences. [How to configure MediaManager.](../configuration/README.md)
{% step %}
#### Start MediaManager
Bring up the stack:
@@ -45,16 +45,15 @@ Bring up the stack:
```bash
docker compose up -d
```
{% endstep %}
{% endstepper %}
* Upon first run, MediaManager will create a default `config.toml` file in the `./config` directory (if not already present).
* Upon first run, MediaManager will also create a default admin user. The credentials of the default admin user will be printed in the logs of the container — it's recommended to change the password of this user after the first login.
* [For more information on the available configuration options, see the Configuration section of the documentation.](configuration/)
* [For more information on the available configuration options, see the Configuration section of the documentation.](../configuration/README.md)
{% hint style="info" %}
When setting up MediaManager for the first time, you should add your email to `admin_emails` in the `[auth]` config section. MediaManager will then use this email instead of the default admin email. Your account will automatically be created as an admin account, allowing you to manage other users, media, and settings.
{% endhint %}
!!! info
When setting up MediaManager for the first time, you should add your email to `admin_emails` in the `[auth]` config section. MediaManager will then use this email instead of the default admin email. Your account will automatically be created as an admin account, allowing you to manage other users, media, and settings.
## Docker Images
@@ -70,9 +69,8 @@ MetadataRelay images are also available on both registries:
From v1.12.1 onwards, both MediaManager and MetadataRelay images are available on both Quay.io and GHCR. The reason for the switch to Quay.io as the primary image registry is due to [GHCR's continued slow performance.](https://github.com/orgs/community/discussions/173607)
{% hint style="info" %}
You can use either the Quay.io or GHCR images interchangeably, as they are built from the same source and the tags are the same across both registries.
{% endhint %}
!!! info
You can use either the Quay.io or GHCR images interchangeably, as they are built from the same source and the tags are the same across both registries.
### Tags