1
0
Fork 1
mirror of https://gitlab.com/mangadex-pub/mangadex_at_home.git synced 2024-01-19 02:48:37 +00:00
mangadex_at_home/docker
2021-02-11 15:54:21 -06:00
..
grafana Update metrics configuration 2021-02-06 08:00:53 +00:00
prometheus Update to next-gen 2021-01-24 04:55:11 +00:00
dashboard.png Update to next-gen 2021-01-24 04:55:11 +00:00
docker-compose.yml Fix graceful shutdown 2021-02-11 15:54:21 -06:00
README.md Update incorrect docker-compose & documentation 2021-01-24 06:33:39 +00:00

Run with Docker

⚠ This is a bit more involved of a setup than just running the jar ⚠

Prerequisites

Docker Desktop for your operating system.

Once installed, you can check that it works by opening a command prompt and running

docker run -it hello-world

Run as a standalone container

Use either a specific image, preferrably the latest image published

While it might work, using registry.gitlab.com/mangadex-pub/mangadex_at_home:latest is a bad idea as we do not guarantee forward-compatibility

Run with Prometheus and Grafana (i.e. dashboards)

Quickstart

  1. Install docker-compose. Follow the steps here

  2. Copy the docker directory somewhere on the drive you want to use as cache storage*

    a. edit docker-compose.yml and replace registry.gitlab.com/mangadex-pub/mangadex_at_home:<version> with the appropriate version

  3. Copy your settings.yaml inside that directory (it should be next to docker-compose.yml)

  4. Run docker-compose up -d from within this directory

  5. That's it. You should now check the following:

Notes

The pre-made configuration is hardcoded both public port 443 and this directory structure:

<directory where you run 'docker-compose up'>

    Folders/files copied from the git repository
    -> prometheus/... - pre-made config
    -> grafana/... - pre-made config
    -> docker-compose.yml

    Your settings.yaml
    -> settings.yaml

    Created by the containers
    -> data/
        -> cache - the client's image cache
        -> prometheus - prometheus database files
        -> grafana - grafana files

All of this is configurable to suit your needs but is not recommended unless you are familiar with Docker already.