From 02df8187e7343ecc0ac5d0e64b3c70e631ae01f2 Mon Sep 17 00:00:00 2001
From: Tristan Deloche <tde@hey.com>
Date: Sun, 24 Jan 2021 05:34:41 +0000
Subject: [PATCH] Update incorrect docker-compose & documentation

---
 CHANGELOG.md              | 31 ++++++++++++++++---------------
 docker/README.md          |  6 +++---
 docker/docker-compose.yml |  2 +-
 3 files changed, 20 insertions(+), 19 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 84349ed..a35ada0 100755
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -14,34 +14,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 
 ### Fixed
+- [2021-01-23] Fix sample docker-compose.yml [@_tde9]
 
 ### Security
 
 ## [2.0.0-rc1] - 2020-01-23
 This release contains many breaking changes! Of note are the changes to the cache folders, database location, and settings format.
 ### Added
-- [2020-01-23] Added `external_max_kilobits_per_second` config option [@carbotaniuman].
-- [2020-01-23] Various internal tests to ensure stability [@carbotaniuman].
-- [2020-01-23] Added `/prometheus` endpoint for Prometheus stats and eventual integration [@Tristan].
-- [2020-01-23] docker-compose for easy spinup of a Prometheus + Grafana stack [@carbotaniuman].
+- [2021-01-23] Added `external_max_kilobits_per_second` config option [@carbotaniuman].
+- [2021-01-23] Various internal tests to ensure stability [@carbotaniuman].
+- [2021-01-23] Added `/prometheus` endpoint for Prometheus stats and eventual integration [@_tde9].
+- [2021-01-23] docker-compose for easy spinup of a Prometheus + Grafana stack [@_tde9].
 
 ### Changed
-- [2020-01-23] Changed the settings to a `settings.yaml` file [@carbotaniuman].
-- [2020-01-23] Changed from `cache` to `images` for images folder [@carbotaniuman].
-- [2020-01-23] Changed folder structure to be simpler [@carbotaniuman].
-- [2020-01-23] Coalesced DB writes to reduce DB load [@carbotaniuman].
-- [2020-01-23] Store metadata along with the image to reduce IOPS [@carbotaniuman].
-- [2020-01-23] Updated internal dependencies to improve performance [@carbotaniuman].
+- [2021-01-23] Changed the settings to a `settings.yaml` file [@carbotaniuman].
+- [2021-01-23] Changed from `cache` to `images` for images folder [@carbotaniuman].
+- [2021-01-23] Changed folder structure to be simpler [@carbotaniuman].
+- [2021-01-23] Coalesced DB writes to reduce DB load [@carbotaniuman].
+- [2021-01-23] Store metadata along with the image to reduce IOPS [@carbotaniuman].
+- [2021-01-23] Updated internal dependencies to improve performance [@carbotaniuman].
 
 ### Removed
 - [2020-01-23] Unceremoniously removed the old WebUI [@carbotaniuman].
 
 ### Fixed
-- [2020-01-23] Fixed a long-standing cache deadlock [@carbotaniuman].
-- [2020-01-23] Fixed another shutdown bug [@carbotaniuman].
-- [2020-01-23] Fixed various CPU and memory leaks [@carbotaniuman].
-- [2020-01-23] Fixed another shutdown bug [@carbotaniuman].
-- [2020-01-23] Fixed data races when storing images [@carbotaniuman].
+- [2021-01-23] Fixed a long-standing cache deadlock [@carbotaniuman].
+- [2021-01-23] Fixed another shutdown bug [@carbotaniuman].
+- [2021-01-23] Fixed various CPU and memory leaks [@carbotaniuman].
+- [2021-01-23] Fixed another shutdown bug [@carbotaniuman].
+- [2021-01-23] Fixed data races when storing images [@carbotaniuman].
 
 ## [1.2.4] - 2021-01-09
 ### Fixed
diff --git a/docker/README.md b/docker/README.md
index 6d9ec52..659f019 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -28,7 +28,7 @@ Use either a specific image, preferrably the [latest image published](https://gi
 
    a. edit `docker-compose.yml` and replace `registry.gitlab.com/mangadex-pub/mangadex_at_home:<version>` with the appropriate version
 
-3. Copy your `settings.json` inside that directory (it should be next to `docker-compose.yml`)
+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
 
@@ -49,8 +49,8 @@ The pre-made configuration is hardcoded both public port 443 and this directory
         -> grafana/... - pre-made config
         -> docker-compose.yml
 
-        Your settings.json
-        -> settings.json
+        Your settings.yaml
+        -> settings.yaml
 
         Created by the containers
         -> data/
diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
index 2b2c4a7..4da412d 100644
--- a/docker/docker-compose.yml
+++ b/docker/docker-compose.yml
@@ -8,7 +8,7 @@ services:
     ports:
       - 443:443
     volumes:
-      - ./settings.json:/mangahome/settings.json:ro
+      - ./settings.yaml:/mangahome/settings.yaml:ro
       - ./data/cache/:/mangahome/data/
     environment:
       JAVA_TOOL_OPTIONS: "-Xms1G -Xmx1G -XX:+UseG1GC -Xss512K"