From 6d5eefd8ecd4f8357766efd718afb25082dae4b2 Mon Sep 17 00:00:00 2001 From: David Luevano Alvarado Date: Tue, 13 Jun 2023 04:17:35 -0600 Subject: rearrange komga server entry content --- live/blog/a/manga_server_with_komga.html | 244 +++++++++++++++---------------- live/blog/rss.xml | 242 +++++++++++++++--------------- live/blog/sitemap.xml | 2 +- 3 files changed, 244 insertions(+), 244 deletions(-) (limited to 'live/blog') diff --git a/live/blog/a/manga_server_with_komga.html b/live/blog/a/manga_server_with_komga.html index 182956d..1dc3242 100644 --- a/live/blog/a/manga_server_with_komga.html +++ b/live/blog/a/manga_server_with_komga.html @@ -95,21 +95,11 @@

Prerequisites

@@ -132,7 +132,7 @@
  • An A (and/or AAAA) or a CNAME for komga (or whatever you want).
  • An SSL certificate, if you’re following the other entries (specially the website entry), add a komga.conf and run certbot --nginx (or similar) to extend/create the certificate. More details below: Reverse proxy and SSL certificate.
    • -

    AUR - yay

    +

    yay

    This is the first time I mention the AUR (and yay) in my entries, so I might as well just write a bit about it.

    The AUR is the Arch Linux User Repository and it’s basically like an extension of the official one which is supported by the community, the only thing is that it requires a different package manager. The one I use (and I think everyone does, too) is yay, which as far as I know is like a wrapper of pacman.

    Install

    @@ -152,105 +152,9 @@ sudo rm -r yay

    To install a package (for example Komga in this blog entry), run:

    yay -S komga
    -

    Komga

    -

    Komga is a comics/mangas media server.

    -

    Install from the AUR:

    -
    yay -S komga
-
    -

    This komga package creates a komga (service) user and group which is tied to the also included komga.service.

    -

    Configure it by editing /etc/komga.conf:

    -
    SERVER_PORT=8989
-SERVER_SERVLET_CONTEXT_PATH=/ # this depends a lot of how it's going to be served (domain, subdomain, ip, etc)
-
-KOMGA_LIBRARIES_SCAN_CRON="0 0 * * * ?"
-KOMGA_LIBRARIES_SCAN_STARTUP=false
-KOMGA_LIBRARIES_SCAN_DIRECTORY_EXCLUSIONS='#recycle,@eaDir,@Recycle'
-KOMGA_FILESYSTEM_SCANNER_FORCE_DIRECTORY_MODIFIED_TIME=false
-KOMGA_REMEMBERME_KEY=USE-WHATEVER-YOU-WANT-HERE
-KOMGA_REMEMBERME_VALIDITY=2419200
-
-KOMGA_DATABASE_BACKUP_ENABLED=true
-KOMGA_DATABASE_BACKUP_STARTUP=true
-KOMGA_DATABASE_BACKUP_SCHEDULE="0 0 */8 * * ?"
-
    -

    My changes (shown above):

    - -

    If you’re going to run it locally (or LAN/VPN) you can start the komga.service and access it via IP at http://<your-server-ip>:<port>(/base_url) as stated at Komga: Accessing the web interface, then you can continue with the mangal section, else continue with the next steps for the reverse proxy and certificate.

    -

    Reverse proxy

    -

    Create the reverse proxy configuration (this is for nginx). In my case I’ll use a subdomain, so this is a new config called komga.conf at the usual sites-available/enabled path:

    -
    server {
-    listen 80;
-    server_name komga.yourdomain.com; # change accordingly to your wanted subdomain and domain name
-
-    location / {
-        proxy_pass http://localhost:8989; # change 8989 to the port you want to use
-
-        proxy_set_header Host $host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header X-Forwarded-Proto $scheme;
-
-        proxy_read_timeout 600s;
-        proxy_send_timeout 600s;
-    }
-}
-
    -

    If it’s going to be used as a subdir on another domain then just change the location with /subdir instead of /; be careful with the proxy_pass directive, it has to match what you configured at /etc/komga.conf for the SERVER_SERVLET_CONTEXT_PATH regardless of the /subdir you selected at location.

    -

    SSL certificate

    -

    If using a subdir then the same certificate for the subdomain/domain should work fine and no extra stuff is needed, else if following along me then we can create/extend the certificate by running:

    -
    certbot --nginx
-
    -

    That will automatically detect the new subdomain config and create/extend your existing certificate(s). In my case I manage each certificate’s subdomain:

    -
    certbot --nginx -d domainname.com -d subdomain.domainname.com -d komga.domainname.com
-
    -

    Starting using Komga

    -

    We can now start/enable the komga.service:

    -
    systemctl enable komga.service
-systemctl start komga.service
-
    -

    And access the web interface at https://komga.domainname.com which should show the login page for Komga. The first time it will ask to create an account as shown in Komga: Create user account, this will be an admin account. Fill in the email and password (can be changed later). The email doesn’t have to be an actual email, for now it’s just for management purposes.

    -

    Next thing would be to add any extra account (for read-only/download manga permissions), add/import libraries, etc.. For now I’ll leave it here until we start downloading manga on the next steps.

    -

    Library creation

    -

    Creating a library is as simple as creating a directory somewhere and point to it in Komga. The folowing examples are for my use case, change accordingly. I’ll be using /mnt/d/mangal for my library:

    -
    mkdir /mnt/d/mangal
-
    -

    Where I chose the name mangal as its the name of the downloader/scrapper I’m going to use, it could be anything, this is just how I like to organize stuff.

    -

    For the most part, the permissions don’t matter much (as long as it’s readable by the komga user) unless you want to delete some manga, then komga user also needs write permissions.

    -

    Then just create the library in Komga web interface (the + sign next to Libraries), choose a name “Mangal” and point to the root folder /mnt/d/mangal, then just click Next, Next and Add for the defaults (that’s how I’ve been using it so far). This is well explained at Komga: Libraries.

    -

    The real important part (for me) is the permissions of the /mnt/d/mangal directory, as I want to have write access for komga so I can manage from the web interface itself. It looks like it’s just a matter of giving ownership to the komga user either for owner or for group (or to all for that matter), but since I’m going to use a separate user to download manga then I need to choose carefully.

    -

    Set default directory permissions

    -

    The desired behaviour is: set komga as group ownership, set write access to group and whenever a new directory/file is created, inherit these permission settings. I found out via this stack exchange answer how to do it. So, for me:

    -
    chown manga-dl:komga /mnt/d/mangal # required for group ownership for komga
-chmod g+s /mnt/d/mangal # required for group permission inheritance
-setfacl -d -m g::rwx /mnt/d/mangal # default permissions for group
-setfacl -d -m o::rx /mnt/d/mangal # default permissions for other (as normal, I think this command can be excluded)
-
    -

    Where manga-dl is the user I created to download manga with. Optionally add -R flag to those 4 commands in case it already has subdirectories/files (this might mess file permissions, but it’s not an issue as far as I konw).

    -

    Checking that the permissions are set correctly (getfacl /mnt/d/mangal):

    -
    getfacl: Removing leading '/' from absolute path names
-# file: mnt/d/mangal
-# owner: manga-dl
-# group: komga
-# flags: -s-
-user::rwx
-group::rwx
-other::r-x
-default:user::rwx
-default:group::rwx
-default:other::r-x
-
    -

    You can then check by creating a new subdirectory (in /mnt/d/mangal) and it should have the same group permissions.

    mangal

    -

    mangal is a cli/tui manga downloader with anilist integration and custom Lua scrapers.

    -

    Similar to Komga, you could install it from the AUR with yay:

    +

    mangal is a CLI/TUI manga downloader with anilist integration and custom Lua scrapers.

    +

    You could install it from the AUR with yay:

    yay -S mangal-bin

    But I’ll use my fork as it contains some fixes and extra stuff.

    @@ -259,7 +163,7 @@ default:other::r-x

    So instad of installing with yay we’ll build it from source. We need to have go installed:

    pacman -S go
    -

    Then clone my fork of mangal and build/install it:

    +

    Then clone my fork of mangal and install it:

    git clone https://github.com/luevano/mangal.git # not sure if you can use SSH to clone
 cd mangal
 make install # or just `make build` and then move the binary to somewhere in your $PATH
@@ -282,6 +186,7 @@ mangal config set -k formats.use -v "cbz" # downloads as pdf by defaul
 mangal config set -k installer.user -v "luevano" # points to my scrapers repository which contains a few extra scrapers and fixes, defaults to metafates' one; this is important if you're using my fork, don't use otherwise as it uses extra stuff I added
 mangal config set -k logs.write -v true # I like to get logs for what happens
    +

    Note: For testing purposes (if you want to explore mangal) set downloader.path later, then set it to where you want once ready to start to populate the Komga library directory (could be after finishing the Komga section).

    For more configs and to read what they’re for:

    mangal config info
    @@ -324,7 +229,7 @@ mangal config set -k logs.write -v true # I like to get logs for what happens

    Download manga using the TUI by selecting the source/scrapper, search the manga/comic you want and then you can select each chapter to download (use tab to select all). This is what I use when downloading manga that already finished publishing, or when I’m just searching and testing out how it downloads the manga (directory name, and manga information).

    Note that some scrapters will contain duplicated chapters, as they have multiple uploaded chapters from the community, usually for different scanlation groups. This happens a lot with MangaDex.

    Inline

    -

    The inline mode is a single terminal command meant to be used to automate stuff or for more advanced options. You can peek a bit into the “documentation” which honestly its ass because it doesn’t explain much. The minimal command for inline according to the help is:

    +

    The inline mode is a single terminal command meant to be used to automate stuff or for more advanced options. You can peek a bit into the “documentation” which honestly it’s ass because it doesn’t explain much. The minimal command for inline according to the mangal help is:

    mangal inline --manga <option> --query <manga-title>

    But this will not produce anything because it also needs --source (or set the default using the config key downloader.default_sources) and either --json which basically just does the search and returns the result in json format or --download to actually download whatever is found; I recommend to do --json first to check that the correct manga will be downloaded then do --download.

    @@ -356,11 +261,10 @@ mangal config set -k logs.write -v true # I like to get logs for what happens
  • I make sure the json output contains the correct manga information: name, url, etc..
    • mangal inline anilist set --name "Kimetsu no Yaiba" --id 101922
    -

    Which means that all “searches” for that --name flag will be attached to that specific anilist ID.

    1. If I’m okay with the outputs, then I change --json for --download to actually download:
    @@ -369,10 +273,6 @@ mangal config set -k logs.write -v true # I like to get logs for what happens
    1. Check if the manga is downloaded correctly. I do this by going to my download directory and checking the directory name (I’m picky with this stuff), that all chapters where downloaded, that it includes a correct series.json file and it contains a cover.<img-ext>; this usually means it correctly pulled information from anilist and that it will contain metadata Komga will be able to use.
    -

    Komga library

    -

    Now I just check that it is correctly added to Komga by clicking on the 3 dots to the right of the library name and click on “Scan library files” to refresh if the cron timer hasn’t activated this yet.

    -

    Then I check that the metadata is correct (once the manga is fully indexed), such as title, summary, chapter count, language, tags, genre, etc., which honestly it never works fine as mangal creates the series.json with the comicId field with an upper case I and Komga expects it to be a lower case i (comicid) so it falls back to using the info from the first chapter. I’ll probably will fix this on mangal side, and see how it goes.

    -

    So, what I do is manually edit the metadata for the manga, by changing whatever it’s wrong or add what’s missing (I like adding anilist and MyAnimeList links) and then leave it as is.

    Automation

    The straight forward approach for automation is just to bundle a bunch of mangal inline commands in a shell script and schedule it’s execution either via cron or systemd/Timers. But, as always, I overcomplicated/overengineered my approach, which is the following:

      @@ -454,7 +354,107 @@ Dandadan|0110|110|Mangapill

      Finally is just a matter of using your prefered way of scheduling, I’ll use systemd/Timers but anything is fine. You could make the downloader script more sophisticated and only running every week on which each manga gets (usually) released but that’s too much work; I’ll just run it once daily probably.

      A feature I want to add and probably will is sending notifications (probably through email) on a summary for manga downloaded or failed to download so I’m on top of the updates. For now this is good enough and it’s been working so far.

      -

      Alternative downloaders

      +

      Komga

      +

      Komga is a comics/mangas media server.

      +

      Install from the AUR:

      +
      yay -S komga
+
      +

      This komga package creates a komga (service) user and group which is tied to the also included komga.service.

      +

      Configure it by editing /etc/komga.conf:

      +
      SERVER_PORT=8989
+SERVER_SERVLET_CONTEXT_PATH=/ # this depends a lot of how it's going to be served (domain, subdomain, ip, etc)
+
+KOMGA_LIBRARIES_SCAN_CRON="0 0 * * * ?"
+KOMGA_LIBRARIES_SCAN_STARTUP=false
+KOMGA_LIBRARIES_SCAN_DIRECTORY_EXCLUSIONS='#recycle,@eaDir,@Recycle'
+KOMGA_FILESYSTEM_SCANNER_FORCE_DIRECTORY_MODIFIED_TIME=false
+KOMGA_REMEMBERME_KEY=USE-WHATEVER-YOU-WANT-HERE
+KOMGA_REMEMBERME_VALIDITY=2419200
+
+KOMGA_DATABASE_BACKUP_ENABLED=true
+KOMGA_DATABASE_BACKUP_STARTUP=true
+KOMGA_DATABASE_BACKUP_SCHEDULE="0 0 */8 * * ?"
+
      +

      My changes (shown above):

      + +

      If you’re going to run it locally (or LAN/VPN) you can start the komga.service and access it via IP at http://<your-server-ip>:<port>(/base_url) as stated at Komga: Accessing the web interface, then you can continue with the mangal section, else continue with the next steps for the reverse proxy and certificate.

      +

      Reverse proxy

      +

      Create the reverse proxy configuration (this is for nginx). In my case I’ll use a subdomain, so this is a new config called komga.conf at the usual sites-available/enabled path:

      +
      server {
+    listen 80;
+    server_name komga.yourdomain.com; # change accordingly to your wanted subdomain and domain name
+
+    location / {
+        proxy_pass http://localhost:8989; # change 8989 to the port you want to use
+
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+
+        proxy_read_timeout 600s;
+        proxy_send_timeout 600s;
+    }
+}
+
      +

      If it’s going to be used as a subdir on another domain then just change the location with /subdir instead of /; be careful with the proxy_pass directive, it has to match what you configured at /etc/komga.conf for the SERVER_SERVLET_CONTEXT_PATH regardless of the /subdir you selected at location.

      +

      SSL certificate

      +

      If using a subdir then the same certificate for the subdomain/domain should work fine and no extra stuff is needed, else if following along me then we can create/extend the certificate by running:

      +
      certbot --nginx
+
      +

      That will automatically detect the new subdomain config and create/extend your existing certificate(s). In my case I manage each certificate’s subdomain:

      +
      certbot --nginx -d domainname.com -d subdomain.domainname.com -d komga.domainname.com
+
      +

      Starting using Komga

      +

      We can now start/enable the komga.service:

      +
      systemctl enable komga.service
+systemctl start komga.service
+
      +

      And access the web interface at https://komga.domainname.com which should show the login page for Komga. The first time it will ask to create an account as shown in Komga: Create user account, this will be an admin account. Fill in the email and password (can be changed later). The email doesn’t have to be an actual email, for now it’s just for management purposes.

      +

      Next thing would be to add any extra account (for read-only/download manga permissions), add/import libraries, etc.. For now I’ll leave it here until we start downloading manga on the next steps.

      +

      Library creation

      +

      Creating a library is as simple as creating a directory somewhere and point to it in Komga. The following examples are for my use case, change accordingly. I’ll be using /mnt/d/mangal for my library (as stated in the mangal: configuration section):

      +
      mkdir /mnt/d/mangal
+
      +

      Where I chose the name mangal as its the name of the downloader/scrapper, it could be anything, this is just how I like to organize stuff.

      +

      For the most part, the permissions don’t matter much (as long as it’s readable by the komga user) unless you want to delete some manga, then komga user also needs write permissions.

      +

      Then just create the library in Komga web interface (the + sign next to Libraries), choose a name “Mangal” and point to the root folder /mnt/d/mangal, then just click Next, Next and Add for the defaults (that’s how I’ve been using it so far). This is well explained at Komga: Libraries.

      +

      The real important part (for me) is the permissions of the /mnt/d/mangal directory, as I want to have write access for komga so I can manage from the web interface itself. It looks like it’s just a matter of giving ownership to the komga user either for owner or for group (or to all for that matter), but since I’m going to use a separate user to download manga then I need to choose carefully.

      +

      Set default directory permissions

      +

      The desired behaviour is: set komga as group ownership, set write access to group and whenever a new directory/file is created, inherit these permission settings. I found out via this stack exchange answer how to do it. So, for me:

      +
      chown manga-dl:komga /mnt/d/mangal # required for group ownership for komga
+chmod g+s /mnt/d/mangal # required for group permission inheritance
+setfacl -d -m g::rwx /mnt/d/mangal # default permissions for group
+setfacl -d -m o::rx /mnt/d/mangal # default permissions for other (as normal, I think this command can be excluded)
+
      +

      Where manga-dl is the user I created to download manga with. Optionally add -R flag to those 4 commands in case it already has subdirectories/files (this might mess file permissions, but it’s not an issue as far as I konw).

      +

      Checking that the permissions are set correctly (getfacl /mnt/d/mangal):

      +
      getfacl: Removing leading '/' from absolute path names
+# file: mnt/d/mangal
+# owner: manga-dl
+# group: komga
+# flags: -s-
+user::rwx
+group::rwx
+other::r-x
+default:user::rwx
+default:group::rwx
+default:other::r-x
+
      +

      You can then check by creating a new subdirectory (in /mnt/d/mangal) and it should have the same group permissions.

      +

      Populate manga library

      +

      You can now start downloading manga using mangal either manually or by running the cron/systemd/Timers and it will be detected by Komga automatically when it scans the library (once every hour according to my config). You can manually scan the library, though, by clicking on the 3 dots to the right of the library name (in Komga) and click on “Scan library files”.

      +

      Then you can check that the metadata is correct (once the manga is fully indexed and metadata finished building), such as title, summary, chapter count, language, tags, genre, etc., which honestly it never works fine as mangal creates the series.json with the comicId field with an upper case I and Komga expects it to be a lower case i (comicid) so it falls back to using the info from the first chapter. I’ll probably will fix this on mangal side, and see how it goes.

      +

      So, what I do is manually edit the metadata for the manga, by changing whatever it’s wrong or add what’s missing (I like adding anilist and MyAnimeList links) and then leave it as is. This is up to you.

      +

      Alternative downloaders

      Just for the record, here is a list of downloaders/scrapers I considered before starting to use mangal:

      -

      AUR - yay

      +

      yay

      This is the first time I mention the AUR (and yay) in my entries, so I might as well just write a bit about it.

      The AUR is the Arch Linux User Repository and it’s basically like an extension of the official one which is supported by the community, the only thing is that it requires a different package manager. The one I use (and I think everyone does, too) is yay, which as far as I know is like a wrapper of pacman.

      Install

      @@ -98,105 +98,9 @@ sudo rm -r yay

      To install a package (for example Komga in this blog entry), run:

      yay -S komga
      -

      Komga

      -

      Komga is a comics/mangas media server.

      -

      Install from the AUR:

      -
      yay -S komga
-
      -

      This komga package creates a komga (service) user and group which is tied to the also included komga.service.

      -

      Configure it by editing /etc/komga.conf:

      -
      SERVER_PORT=8989
-SERVER_SERVLET_CONTEXT_PATH=/ # this depends a lot of how it's going to be served (domain, subdomain, ip, etc)
-
-KOMGA_LIBRARIES_SCAN_CRON="0 0 * * * ?"
-KOMGA_LIBRARIES_SCAN_STARTUP=false
-KOMGA_LIBRARIES_SCAN_DIRECTORY_EXCLUSIONS='#recycle,@eaDir,@Recycle'
-KOMGA_FILESYSTEM_SCANNER_FORCE_DIRECTORY_MODIFIED_TIME=false
-KOMGA_REMEMBERME_KEY=USE-WHATEVER-YOU-WANT-HERE
-KOMGA_REMEMBERME_VALIDITY=2419200
-
-KOMGA_DATABASE_BACKUP_ENABLED=true
-KOMGA_DATABASE_BACKUP_STARTUP=true
-KOMGA_DATABASE_BACKUP_SCHEDULE="0 0 */8 * * ?"
-
      -

      My changes (shown above):

      - -

      If you’re going to run it locally (or LAN/VPN) you can start the komga.service and access it via IP at http://<your-server-ip>:<port>(/base_url) as stated at Komga: Accessing the web interface, then you can continue with the mangal section, else continue with the next steps for the reverse proxy and certificate.

      -

      Reverse proxy

      -

      Create the reverse proxy configuration (this is for nginx). In my case I’ll use a subdomain, so this is a new config called komga.conf at the usual sites-available/enabled path:

      -
      server {
-    listen 80;
-    server_name komga.yourdomain.com; # change accordingly to your wanted subdomain and domain name
-
-    location / {
-        proxy_pass http://localhost:8989; # change 8989 to the port you want to use
-
-        proxy_set_header Host $host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header X-Forwarded-Proto $scheme;
-
-        proxy_read_timeout 600s;
-        proxy_send_timeout 600s;
-    }
-}
-
      -

      If it’s going to be used as a subdir on another domain then just change the location with /subdir instead of /; be careful with the proxy_pass directive, it has to match what you configured at /etc/komga.conf for the SERVER_SERVLET_CONTEXT_PATH regardless of the /subdir you selected at location.

      -

      SSL certificate

      -

      If using a subdir then the same certificate for the subdomain/domain should work fine and no extra stuff is needed, else if following along me then we can create/extend the certificate by running:

      -
      certbot --nginx
-
      -

      That will automatically detect the new subdomain config and create/extend your existing certificate(s). In my case I manage each certificate’s subdomain:

      -
      certbot --nginx -d domainname.com -d subdomain.domainname.com -d komga.domainname.com
-
      -

      Starting using Komga

      -

      We can now start/enable the komga.service:

      -
      systemctl enable komga.service
-systemctl start komga.service
-
      -

      And access the web interface at https://komga.domainname.com which should show the login page for Komga. The first time it will ask to create an account as shown in Komga: Create user account, this will be an admin account. Fill in the email and password (can be changed later). The email doesn’t have to be an actual email, for now it’s just for management purposes.

      -

      Next thing would be to add any extra account (for read-only/download manga permissions), add/import libraries, etc.. For now I’ll leave it here until we start downloading manga on the next steps.

      -

      Library creation

      -

      Creating a library is as simple as creating a directory somewhere and point to it in Komga. The folowing examples are for my use case, change accordingly. I’ll be using /mnt/d/mangal for my library:

      -
      mkdir /mnt/d/mangal
-
      -

      Where I chose the name mangal as its the name of the downloader/scrapper I’m going to use, it could be anything, this is just how I like to organize stuff.

      -

      For the most part, the permissions don’t matter much (as long as it’s readable by the komga user) unless you want to delete some manga, then komga user also needs write permissions.

      -

      Then just create the library in Komga web interface (the + sign next to Libraries), choose a name “Mangal” and point to the root folder /mnt/d/mangal, then just click Next, Next and Add for the defaults (that’s how I’ve been using it so far). This is well explained at Komga: Libraries.

      -

      The real important part (for me) is the permissions of the /mnt/d/mangal directory, as I want to have write access for komga so I can manage from the web interface itself. It looks like it’s just a matter of giving ownership to the komga user either for owner or for group (or to all for that matter), but since I’m going to use a separate user to download manga then I need to choose carefully.

      -

      Set default directory permissions

      -

      The desired behaviour is: set komga as group ownership, set write access to group and whenever a new directory/file is created, inherit these permission settings. I found out via this stack exchange answer how to do it. So, for me:

      -
      chown manga-dl:komga /mnt/d/mangal # required for group ownership for komga
-chmod g+s /mnt/d/mangal # required for group permission inheritance
-setfacl -d -m g::rwx /mnt/d/mangal # default permissions for group
-setfacl -d -m o::rx /mnt/d/mangal # default permissions for other (as normal, I think this command can be excluded)
-
      -

      Where manga-dl is the user I created to download manga with. Optionally add -R flag to those 4 commands in case it already has subdirectories/files (this might mess file permissions, but it’s not an issue as far as I konw).

      -

      Checking that the permissions are set correctly (getfacl /mnt/d/mangal):

      -
      getfacl: Removing leading '/' from absolute path names
-# file: mnt/d/mangal
-# owner: manga-dl
-# group: komga
-# flags: -s-
-user::rwx
-group::rwx
-other::r-x
-default:user::rwx
-default:group::rwx
-default:other::r-x
-
      -

      You can then check by creating a new subdirectory (in /mnt/d/mangal) and it should have the same group permissions.

      mangal

      -

      mangal is a cli/tui manga downloader with anilist integration and custom Lua scrapers.

      -

      Similar to Komga, you could install it from the AUR with yay:

      +

      mangal is a CLI/TUI manga downloader with anilist integration and custom Lua scrapers.

      +

      You could install it from the AUR with yay:

      yay -S mangal-bin

      But I’ll use my fork as it contains some fixes and extra stuff.

      @@ -205,7 +109,7 @@ default:other::r-x

      So instad of installing with yay we’ll build it from source. We need to have go installed:

      pacman -S go
      -

      Then clone my fork of mangal and build/install it:

      +

      Then clone my fork of mangal and install it:

      git clone https://github.com/luevano/mangal.git # not sure if you can use SSH to clone
 cd mangal
 make install # or just `make build` and then move the binary to somewhere in your $PATH
@@ -228,6 +132,7 @@ mangal config set -k formats.use -v "cbz" # downloads as pdf by defaul
 mangal config set -k installer.user -v "luevano" # points to my scrapers repository which contains a few extra scrapers and fixes, defaults to metafates' one; this is important if you're using my fork, don't use otherwise as it uses extra stuff I added
 mangal config set -k logs.write -v true # I like to get logs for what happens
      +

      Note: For testing purposes (if you want to explore mangal) set downloader.path later, then set it to where you want once ready to start to populate the Komga library directory (could be after finishing the Komga section).

      For more configs and to read what they’re for:

      mangal config info
      @@ -270,7 +175,7 @@ mangal config set -k logs.write -v true # I like to get logs for what happens

      Download manga using the TUI by selecting the source/scrapper, search the manga/comic you want and then you can select each chapter to download (use tab to select all). This is what I use when downloading manga that already finished publishing, or when I’m just searching and testing out how it downloads the manga (directory name, and manga information).

      Note that some scrapters will contain duplicated chapters, as they have multiple uploaded chapters from the community, usually for different scanlation groups. This happens a lot with MangaDex.

      Inline

      -

      The inline mode is a single terminal command meant to be used to automate stuff or for more advanced options. You can peek a bit into the “documentation” which honestly its ass because it doesn’t explain much. The minimal command for inline according to the help is:

      +

      The inline mode is a single terminal command meant to be used to automate stuff or for more advanced options. You can peek a bit into the “documentation” which honestly it’s ass because it doesn’t explain much. The minimal command for inline according to the mangal help is:

      mangal inline --manga <option> --query <manga-title>

      But this will not produce anything because it also needs --source (or set the default using the config key downloader.default_sources) and either --json which basically just does the search and returns the result in json format or --download to actually download whatever is found; I recommend to do --json first to check that the correct manga will be downloaded then do --download.

      @@ -302,11 +207,10 @@ mangal config set -k logs.write -v true # I like to get logs for what happens
    1. I make sure the json output contains the correct manga information: name, url, etc..
    mangal inline anilist set --name "Kimetsu no Yaiba" --id 101922
    -

    Which means that all “searches” for that --name flag will be attached to that specific anilist ID.

    1. If I’m okay with the outputs, then I change --json for --download to actually download:
    @@ -315,10 +219,6 @@ mangal config set -k logs.write -v true # I like to get logs for what happens
    1. Check if the manga is downloaded correctly. I do this by going to my download directory and checking the directory name (I’m picky with this stuff), that all chapters where downloaded, that it includes a correct series.json file and it contains a cover.<img-ext>; this usually means it correctly pulled information from anilist and that it will contain metadata Komga will be able to use.
    -

    Komga library

    -

    Now I just check that it is correctly added to Komga by clicking on the 3 dots to the right of the library name and click on “Scan library files” to refresh if the cron timer hasn’t activated this yet.

    -

    Then I check that the metadata is correct (once the manga is fully indexed), such as title, summary, chapter count, language, tags, genre, etc., which honestly it never works fine as mangal creates the series.json with the comicId field with an upper case I and Komga expects it to be a lower case i (comicid) so it falls back to using the info from the first chapter. I’ll probably will fix this on mangal side, and see how it goes.

    -

    So, what I do is manually edit the metadata for the manga, by changing whatever it’s wrong or add what’s missing (I like adding anilist and MyAnimeList links) and then leave it as is.

    Automation

    The straight forward approach for automation is just to bundle a bunch of mangal inline commands in a shell script and schedule it’s execution either via cron or systemd/Timers. But, as always, I overcomplicated/overengineered my approach, which is the following:

      @@ -400,7 +300,107 @@ Dandadan|0110|110|Mangapill

      Finally is just a matter of using your prefered way of scheduling, I’ll use systemd/Timers but anything is fine. You could make the downloader script more sophisticated and only running every week on which each manga gets (usually) released but that’s too much work; I’ll just run it once daily probably.

      A feature I want to add and probably will is sending notifications (probably through email) on a summary for manga downloaded or failed to download so I’m on top of the updates. For now this is good enough and it’s been working so far.

      -

      Alternative downloaders

      +

      Komga

      +

      Komga is a comics/mangas media server.

      +

      Install from the AUR:

      +
      yay -S komga
+
      +

      This komga package creates a komga (service) user and group which is tied to the also included komga.service.

      +

      Configure it by editing /etc/komga.conf:

      +
      SERVER_PORT=8989
+SERVER_SERVLET_CONTEXT_PATH=/ # this depends a lot of how it's going to be served (domain, subdomain, ip, etc)
+
+KOMGA_LIBRARIES_SCAN_CRON="0 0 * * * ?"
+KOMGA_LIBRARIES_SCAN_STARTUP=false
+KOMGA_LIBRARIES_SCAN_DIRECTORY_EXCLUSIONS='#recycle,@eaDir,@Recycle'
+KOMGA_FILESYSTEM_SCANNER_FORCE_DIRECTORY_MODIFIED_TIME=false
+KOMGA_REMEMBERME_KEY=USE-WHATEVER-YOU-WANT-HERE
+KOMGA_REMEMBERME_VALIDITY=2419200
+
+KOMGA_DATABASE_BACKUP_ENABLED=true
+KOMGA_DATABASE_BACKUP_STARTUP=true
+KOMGA_DATABASE_BACKUP_SCHEDULE="0 0 */8 * * ?"
+
      +

      My changes (shown above):

      + +

      If you’re going to run it locally (or LAN/VPN) you can start the komga.service and access it via IP at http://<your-server-ip>:<port>(/base_url) as stated at Komga: Accessing the web interface, then you can continue with the mangal section, else continue with the next steps for the reverse proxy and certificate.

      +

      Reverse proxy

      +

      Create the reverse proxy configuration (this is for nginx). In my case I’ll use a subdomain, so this is a new config called komga.conf at the usual sites-available/enabled path:

      +
      server {
+    listen 80;
+    server_name komga.yourdomain.com; # change accordingly to your wanted subdomain and domain name
+
+    location / {
+        proxy_pass http://localhost:8989; # change 8989 to the port you want to use
+
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+
+        proxy_read_timeout 600s;
+        proxy_send_timeout 600s;
+    }
+}
+
      +

      If it’s going to be used as a subdir on another domain then just change the location with /subdir instead of /; be careful with the proxy_pass directive, it has to match what you configured at /etc/komga.conf for the SERVER_SERVLET_CONTEXT_PATH regardless of the /subdir you selected at location.

      +

      SSL certificate

      +

      If using a subdir then the same certificate for the subdomain/domain should work fine and no extra stuff is needed, else if following along me then we can create/extend the certificate by running:

      +
      certbot --nginx
+
      +

      That will automatically detect the new subdomain config and create/extend your existing certificate(s). In my case I manage each certificate’s subdomain:

      +
      certbot --nginx -d domainname.com -d subdomain.domainname.com -d komga.domainname.com
+
      +

      Starting using Komga

      +

      We can now start/enable the komga.service:

      +
      systemctl enable komga.service
+systemctl start komga.service
+
      +

      And access the web interface at https://komga.domainname.com which should show the login page for Komga. The first time it will ask to create an account as shown in Komga: Create user account, this will be an admin account. Fill in the email and password (can be changed later). The email doesn’t have to be an actual email, for now it’s just for management purposes.

      +

      Next thing would be to add any extra account (for read-only/download manga permissions), add/import libraries, etc.. For now I’ll leave it here until we start downloading manga on the next steps.

      +

      Library creation

      +

      Creating a library is as simple as creating a directory somewhere and point to it in Komga. The following examples are for my use case, change accordingly. I’ll be using /mnt/d/mangal for my library (as stated in the mangal: configuration section):

      +
      mkdir /mnt/d/mangal
+
      +

      Where I chose the name mangal as its the name of the downloader/scrapper, it could be anything, this is just how I like to organize stuff.

      +

      For the most part, the permissions don’t matter much (as long as it’s readable by the komga user) unless you want to delete some manga, then komga user also needs write permissions.

      +

      Then just create the library in Komga web interface (the + sign next to Libraries), choose a name “Mangal” and point to the root folder /mnt/d/mangal, then just click Next, Next and Add for the defaults (that’s how I’ve been using it so far). This is well explained at Komga: Libraries.

      +

      The real important part (for me) is the permissions of the /mnt/d/mangal directory, as I want to have write access for komga so I can manage from the web interface itself. It looks like it’s just a matter of giving ownership to the komga user either for owner or for group (or to all for that matter), but since I’m going to use a separate user to download manga then I need to choose carefully.

      +

      Set default directory permissions

      +

      The desired behaviour is: set komga as group ownership, set write access to group and whenever a new directory/file is created, inherit these permission settings. I found out via this stack exchange answer how to do it. So, for me:

      +
      chown manga-dl:komga /mnt/d/mangal # required for group ownership for komga
+chmod g+s /mnt/d/mangal # required for group permission inheritance
+setfacl -d -m g::rwx /mnt/d/mangal # default permissions for group
+setfacl -d -m o::rx /mnt/d/mangal # default permissions for other (as normal, I think this command can be excluded)
+
      +

      Where manga-dl is the user I created to download manga with. Optionally add -R flag to those 4 commands in case it already has subdirectories/files (this might mess file permissions, but it’s not an issue as far as I konw).

      +

      Checking that the permissions are set correctly (getfacl /mnt/d/mangal):

      +
      getfacl: Removing leading '/' from absolute path names
+# file: mnt/d/mangal
+# owner: manga-dl
+# group: komga
+# flags: -s-
+user::rwx
+group::rwx
+other::r-x
+default:user::rwx
+default:group::rwx
+default:other::r-x
+
      +

      You can then check by creating a new subdirectory (in /mnt/d/mangal) and it should have the same group permissions.

      +

      Populate manga library

      +

      You can now start downloading manga using mangal either manually or by running the cron/systemd/Timers and it will be detected by Komga automatically when it scans the library (once every hour according to my config). You can manually scan the library, though, by clicking on the 3 dots to the right of the library name (in Komga) and click on “Scan library files”.

      +

      Then you can check that the metadata is correct (once the manga is fully indexed and metadata finished building), such as title, summary, chapter count, language, tags, genre, etc., which honestly it never works fine as mangal creates the series.json with the comicId field with an upper case I and Komga expects it to be a lower case i (comicid) so it falls back to using the info from the first chapter. I’ll probably will fix this on mangal side, and see how it goes.

      +

      So, what I do is manually edit the metadata for the manga, by changing whatever it’s wrong or add what’s missing (I like adding anilist and MyAnimeList links) and then leave it as is. This is up to you.

      +

      Alternative downloaders

      Just for the record, here is a list of downloaders/scrapers I considered before starting to use mangal: