mangatsu/server

🌕 Media server for storing, tagging and viewing doujinshi, manga, art collections and other galleries with API and user control. Written in Go.

Mangatsu

🌕 Server application for storing, tagging and reading doujinshi, manga, art collections and other galleries with API access and user control. Written in Go. The name, Mangatsu, is a play on Japanese words mangetsu (満月, full moon) and manga (漫画, comic).

📰 CHANGELOG | ❤ CONTRIBUTING

At experimental stage until version 1.0.0. Expect breaking changes.

📌 Features

• Organizing and tagging local (and remote, with tools like rclone) collections of manga, doujinshi and other art
  • Mangatsu will never do any writes inside specified locations.
  • Supports ZIP (or CBZ), RAR (or CBR), 7z and plain image (png, jpg, jpeg, webp, avif, heif, gif, tiff, bmp) files.
    • PDF and video support is planned.
• Metadata parsing from filenames and JSON files (inside or beside the archive)
  • Support for more sources is planned such as TXT files from EH/ExH
• API-access to the collection and archives
  • Extensive filtering, sorting and searching capabilities
  • Additional features for registered users such as tracking reading progress and adding favorite groups. Currently only in API, not in UI.
• User access control
  • Private: only logged-in users can access the collection and archives (public registration disabled by default).
  • Restricted: users need a global passphrase to access collection and its galleries
  • Public: anyone can access (only read) collection and its galleries
  • Assignable roles (admin, member, viewer), and login sessions (can be managed through web)
• Local cache and thumbnail support. File server can be disabled to allow web servers like NGINX to handle the files.

🖼️ Preview

Main Catalogue	Main Catalogue (grouped galleries)

Gallery Page + Editing	Series Listing

User Settings	Administration

📌 Clients

🌏 Web client

• Included in the Docker setup below
• Source: Mangatsu Web

📱 Tachiyomi extension for Android

• Coming soon

📌 Installation and usage

📖 Guides

• 📝 Configuration with environmentals
• 📚 Library directory structure

🐳 Docker setup (recommended)

GitHub Container Registry: server & web

DockerHub: server & web images

• Set up a webserver of your choice. NGINX is recommended.
  • Example config. The same config can be used for both the server and the web client. Just change the domains, SSL cert paths and ports.
• Install Docker (Linux, Windows or MacOS)
• Local archives
  • Download the docker-compose.example.yml and rename it to docker-compose.yml
  • Edit the docker-compose.yml file to your needs
  • Create data and archive directories
• Network archives with Rclone
  • Follow the guide on Rclone site
  • Download the docker-compose.rclone.yml and rename it to docker-compose.yml
• Run docker-compose up -d to start the server and web client
• Update by running docker-compose down, docker-compose pull and then docker-compose up -d

💻 Local setup

• Set up server
  • Copy example.env as .env and change the values according to your needs
  • Build go build ./cmd/mangatsu-server
  • Run ./mangatsu-server (mangatsu-server.exe on Windows)
• Set up web
  • Guide on github.com/Mangatsu/web

server's Issues

Parse or save the UserAgent of login requests to have a meaningful session name

Either

• Save the raw user agent as the session name and let client handle the parsing
• OR
• Parse the UserAgent and save the result

server/pkg/api/user.go

Line 74 in d5e49ae

token, err := newJWT(*userUUID, "", credentials.ExpiresIn, credentials.SessionName, role)

Initialize database and database user on first launch if needed

Initialize database and database user on first launch if needed. Also an environmental to disable this should be present.

For example for MySQL/MariaDB it'd be:

CREATE USER '<USERNAME>'@'<ADDRESS>' IDENTIFIED BY '<PASSWORD>';
CREATE DATABASE IF NOT EXISTS <DATABASE_NAME> CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
GRANT ALL PRIVILEGES on <DATABASE_NAME>.* to '<USERNAME>'@'<ADDRESS>';
FLUSH privileges;

The utf8mb4 COLLATE utf8mb4_unicode_ci helps with support for Japanese, Chinese etc. characters.

PDF gallery support

https://github.com/gen2brain/go-fitz is probably useful.

Migrations for other DBMS

https://github.com/pressly/goose

• SQLite3
• #18
  • MySQL
  • MariaDB
  • PostegreSQL

Video gallery support

Video support (at least mp4, webm) in galleries for both the backend and frontend.

Many cosplay and art collections include them.

Backend+Frontend all-in-one binary

Mangatsu/server and Mangatsu/web as single (or one for each OS: Windows, Linux, MacOS if needed) all-in-one binary which could be run as-is.

Create models for the database types (for goqu)

We could probably use the types Jet generated as a base: pkg/types/model.

goqu rework & Support for PostegreSQL, MySQL/MariaDB

The rework is being work on in https://github.com/Mangatsu/server/tree/goqu-rework

Currently only SQLite3 is supported. Support for more databases would be nice.

Supported databases

• SQLite3
• PostgreSQL
• MySQL/MariaDB (optional)

Tasks

• #17
• #16
• #15
• #14
• #23
• #24

Support for periodical scanning

Support for periodical scanning. Allow users to specifify the interval. Maybe library specific (as multiple library locations is supported)?

Expiring cache

Metadata sources

Sources to pull metadata from for galleries like manga and doujinshi.

Create separate issues for individual sources.

• AniList
• nhentai
• e(x)-hentai

What else?

Migrate db.go and library.go to goqu

• Initial rework #20
• Handle the scenario when the ID exists in db in newLibrary
• Rewrite CombinedLibrary struct

Research and test if using Chi as the HTTP router would benefit us

• https://github.com/go-chi/chi
• https://github.com/gorilla/mux (used currently)

7zip gallery support

Migrate user.go to goqu

Migrate gallery.go and validations.go to goqu

This one might be the most challenging part of the goqu rework.

• GetGalleries function is very elaborate and prone to bugs if not converted carefully.
• UpdateGallery can probably be refactored to be much shorter and better written overall. The Jet library made it hard to do partial updates.
• NeedsUpdate isn't used anywhere currently and can be pretty much ignored

Gallery metadata editing

Allow admins to edit gallery metadata through the web app.

• Gallery data
• Gallery reference data
• Tags

TODO list

Web TODO here

Short term

• #12
• #5
• #1
• #2
• #3
• #28
• #4
• #7
• #26
• Better plain file support and general improvements for the scanner and tagger
• More testing especially for the server (db, parsers)
• Allow disabling internal file server to allow for external file serving (like NGINX)
• Group structured manga with the same series names

Long term

• #6
• Improvements to cache policy (e.g. max size)
• Rework sessions to utilize JWT refresh tokens (expire in 5-15 minutes or so)?
• Flutter (or something else) mobile app frontend