🌕 Server application for storing doujinshi, manga, art collections and other galleries with API and user control. Written in Go.

Last update: Dec 31, 2022

Comments: 5

Mangatsu

Still at very experimental stage. Expect lots of breaking changes.

🌕 Server application for storing doujinshi, manga, art collections and other galleries with API and user control. Written in Go.

📰 CHANGELOG | ❤ CONTRIBUTING | 🎯 TODO

📌 Installation and usage

🐳 Docker setup (recommended)

Coming soon for both the server and the web app

💻 Local setup

Coming soon

📌 Clients

🖥 Web interface

Mangatsu Web

📱 Tachiyomi extension for Android

Coming soon

📌 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 the archive location.
- Supports ZIP (or CBZ), RAR (or CBR) and plain image (png, jpg, jpeg, webp, gif, tiff, bmp) files.
  - 7z, PDF and video support is planned.
Metadata parsing from filenames, JSON/TXT files (inside or beside the archive). More to come.
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.
User access control
- Private: only logged-in users can access the collection and archives (registration can be disabled).
- Restricted: users need a global passphrase to access collection and its galleries.
- Public: anyone can access (only read) collection and its galleries.
Users with roles (admin, member, viewer) and indefinite login sessions with the option to log out or delete them
Local cache and thumbnail support

📌 Usage

📝 Configuration

Options inside the .env file:

MTSU_INITIAL_ADMIN_NAME=admin
MTSU_INITIAL_ADMIN_PW=admin321
- Credentials for the initial admin user.
MTSU_HOSTNAME=localhost
MTSU_PORT=5050
- Hostname and port for the server.
MTSU_BASE_PATHS=freeform;/home/user/unstructured-manga;;structured:/home/user/structured-manga
- Root paths to the collection and archives. Relative or absolute paths are accepted.
- First specify the type of the directory (freeform or structured) and then the path separated by a semicolon: ;
- Multiple paths can be separated by a double-semicolon: ;;
MTSU_DATA_PATH=../data
- Location of the data dir which includes the SQLite db and cache for gallery images and thumbnails. Relative or absolute paths are accepted.
MTSU_VISIBILITY=public
- public: anyone can access the collection and its galleries
- restricted: users need a global passphrase to access collection and its galleries
- private: only logged-in users can access the collection and its galleries
MTSU_RESTRICTED_PASSPHRASE=secret321
- Passphrase to access the collection and its galleries.
- Only used when VISIBILITY is set to restricted.
MTSU_REGISTRATIONS=false
- Whether to allow user registrations. If set to false, only admins can create new users. Currently, only affects the API path /register. Has no effect in the frontend.
MTSU_JWT_SECRET=secret123
- Secret value for signing JWT tokens for login sessions in the backend.

📂 Directory structure

Multiple root directories are supported. I suggest creating a structured format for proper long-running manga, and a freeform structure for doujinshi and other art collections. Examples follow:

Freeform: galleries can be up to three levels deep. Good for doujinshi, one-shots and other more unstructured collections.
- External JSON metadata files have to be placed in the same level as the gallery archive. Preferably having the same name as the gallery archive. If no exact match is found, filename close enough will be used instead.
- Option to create categories according to the 1st level of the directory structure. In the example, doujinshi and art would be created as categories. The last lonely archive would be uncategorized.

📂 freeform
├── 📂 doujinshi
│       ├──── 📂 oppai
│       │     ├──── 📦 [Group (Artist)] Ecchi Doujinshi.cbz
│       │     └──── 📄 [Group (Artist)] Ecchi Doujinshi.json
│       ├──── 📦 (C99) [Group (Artist)] elfs.zip
│       ├──── 📄 (C99) [Group (Artist)] elfs.json
│       └──── 📦 (C88) [kroup (author, another author)] Tankoubon [DL].zip  (JSON or TXT metafile inside)
├── 📂 art
│       ├──── 📂 [Artist] Pixiv collection
│       │     ├──── 🖼️ 0001.jpg
│       │     ├────...
│       │     └──── 🖼️ 0300.jpg
│       ├──── 📦 art collection y.rar
│       └──── 📄 art collection y.json
└── 📦 (C93) [group (artist)] Lonely doujinshi (Magical Girls).cbz

Structured: galleries follow a strict structure. Good for long-running manga (shounen, seinen etc).
- Manga -> Volumes -> Chapters, Manga -> Volumes or Manga -> Chapters
- Galleries' Series is set to the name of the 1st level directory except for galleries in the root directory.

📂 structured
├── 📕 Manga 1
│       ├── 📦 Volume 1.cbz
│       ├── 📦 Volume 2.cbz
│       ├── 📦 Volume 3.cbz
│       └── 📦 Volume 4.zip
├── 📘 Manga 2
│       └── 📂 Vol. 1
│           ├── 📦 Chapter 1.zip
│           ├── 📦 Chapter 2.zip
│           └── 📦 Chapter 3.rar
├── 📗 Manga 3
│       ├── 📦 Chapter 1.zip
│       ├── ...
│       └── 📦 Chapter 30.rar
└── 📦 One Shot Manga.rar

Comments

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

https://github.com/Mangatsu/server/blob/d5e49ae09508adf12ee31939a6d642b238e64da7/pkg/api/user.go#L74
Migrate `db.go`, `library.go` to goqu
Fixes #14

As said in the beginning of library.go:

// FIXME: it won't work yet!! CombinedLibrary has to be a plain struct, // something like this: // // type User struct { // FirstName string `db:"first_name"` // LastName string `db:"last_name"` // }

We need to create "model" structs with column names in db tags.

And also for now, newLibrary doesn't handle the case when an ID exists. I haven't tested the code because we don't have those annotated model structs, as said earlier.
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
Initialize database and database user on first launch if needed
Initialize database and database user on first launch if needed. Also an environmen var to disable this completely.

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;

but in Go.

The utf8mb4 COLLATE utf8mb4_unicode_ci helps with support for Japanese, Chinese etc. characters.
TODO list
Web TODO here

Short term

[x] #12

[ ] #5

[ ] #1

[ ] #2

[ ] #3

[ ] #4

[ ] #7

[x] #26

[ ] Better plain file support and general improvements for the scanner and tagger

[ ] More testing especially for the server (db, parsers)

[x] Allow disabling internal file server to allow for external file serving (like NGINX)

[x] 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

🌕 Server application for storing doujinshi, manga, art collections and other galleries with API and user control. Written in Go.

Mangatsu

Still at very experimental stage. Expect lots of breaking changes.

📰 CHANGELOG | ❤ CONTRIBUTING | 🎯 TODO

📌 Installation and usage

🐳 Docker setup (recommended)

💻 Local setup

📌 Clients

🖥 Web interface

📱 Tachiyomi extension for Android

📌 Features

📌 Usage

📝 Configuration

📂 Directory structure

Owner

Comments

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

Migrate `db.go`, `library.go` to goqu

Migrate gallery.go and validations.go to goqu

Initialize database and database user on first launch if needed

TODO list

Web TODO here

Short term

Long term

Related tags

🐈📦 nyaa.si client library for Go. Fetch Anime, Manga, Music and more torrents

Go Http Proxy with Authentication, Schedule Control, and Portal Control

Simple tool to handle hosts file black lists that can remove comments, remove duplicates, compress to 9 domains per line, add IPv6 entries, as well as can convert black lists to multiple other black list formats compatible with other software.

concurrent caching proxy and decoder library for collections of PMTiles

MPD client inspired by ncmpcpp written in GO with builtin cover art previews.

Tapestry is an underlying distributed object location and retrieval system (DOLR) which can be used to store and locate objects. This distributed system provides an interface for storing and retrieving key-value pairs.

App with CRUD for user, with palindrome checker for user's first and last name

The server-pubsub is the main backend of DATAVOC project that manages all the other web-server modules of the same project such as the processor

API server for BFE control plane

server-to-server sync application, written in go/golang.

A suite of tools for NFT generative art.

Archiving Street Art in a distributed manner

Headscale - An open source, self-hosted implementation of the Tailscale control server

This app brings the Matterbridge binary to your server to connect Nextcloud Talk with other chat services

Transparent TLS and HTTP proxy serve and operate on all 65535 ports, with domain regex whitelist and rest api control

Control your legacy Reciva based internet radios (Crane, Grace Digital, Tangent, etc.) via REST api or web browser.

Uses the Finger user information protocol to open a TCP connection that makes a request to a Finger server

High-performance PHP application server, load-balancer and process manager written in Golang

High-performance PHP application server, load-balancer and process manager written in Golang