Mango/README.md

2.2 KiB

Mango

banner

Mango is a self-hosted manga server and reader. Its features include

  • Multi-user support
  • Supports both .zip and .cbz formats
  • Automatically stores reading progress
  • The web reader is responsive and works well on mobile, so there is no need for a mobile app
  • All the static files are embedded in the binary, so the deployment process is easy and painless

Installation

Docker

Build from source

  1. Make sure you have Crystal, Node and Yarn installed
  2. Clone the repository
  3. make && sudo make install
  4. Start mango by running the command mango

Usage

CLI

Mango e-manga server/reader. Version 0.1.0

    -v, --version                    Show version
    -h, --help                       Show help
    -c PATH, --config=PATH           Path to the config file. Default is `~/.config/mango/config.yml`

Config

The default config file location is ~/.config/mango/config.yml. The config options and default values are given below

---
port: 9000
library_path: ~/mango/library
db_path: ~/mango/mango.db
scan_interval_minutes: 5
log_level: info
  • scan_interval_minutes can be any non-negative integer. Setting it to 0 disables the periodic scan
  • log_level can be debug, info, warn, error, fatal or off. Setting it to off disables the logging

Required Library Structure

Please make sure that your library directory has the following structure:

.
├── Manga 1
│   └── Manga 1.cbz
└── Manga 2
    ├── Vol 0001.zip
    ├── Vol 0002.zip
    ├── Vol 0003.zip
    ├── Vol 0004.zip
    └── Vol 0005.zip

Initial Login

On the first run, Mango would log the default username and a randomly generated password to STDOUT. You are advised to immediately change the password.

Screenshots

Library

library screenshot

Title

title screenshot

Reader

reader screenshot

Mobile UI

mobile screenshot

Contributors