edward/mangadex-home-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
No description
221 commits 3 branches 0 tags 948 KiB
Rust 92.3%
HTML 7.3%
Dockerfile 0.4%
Find a file
Edward Shen 6d6bf7371b
Add dockerfile
2021-07-18 21:27:29 -04:00
.github/workflows Add sqlx envs 2021-07-12 01:44:01 -04:00
.vscode initial proof of concept 2021-03-17 21:45:16 -04:00
db_queries Add unit tests 2021-07-14 21:56:29 -04:00
docs initial work 2021-07-09 14:36:04 -04:00
src Remove unneeded imports 2021-07-18 18:35:22 -04:00
.dockerignore Add dockerfile 2021-07-18 21:27:29 -04:00
.gitignore Add geo ip logging support 2021-07-15 02:14:04 -04:00
build.rs add sqlx check 2021-07-12 01:34:37 -04:00
Cargo.lock Bump to 0.5.3 2021-07-17 13:05:13 -04:00
Cargo.toml Bump to 0.5.3 2021-07-17 13:05:13 -04:00
Dockerfile Add dockerfile 2021-07-18 21:27:29 -04:00
LICENSE switch to GPLv3 or later 2021-04-17 22:12:02 -04:00
README.md Update readme 2021-07-17 13:04:39 -04:00
settings.sample.yaml Remove encryption option warning 2021-07-17 12:52:41 -04:00
sqlx-data.json Read legacy path on disk 2021-07-15 13:25:46 -04:00

README.md

A Rust implementation of a MangaDex@Home client.

This client contains the following features:

  • Easy migration from the official client
  • Fully compliant with MangaDex@Home specifications
  • Multi-threaded, high performance, and low overhead client
  • HTTP/2 support for API users, HTTP/2 only for upstream connections
  • Secure and privacy oriented features:
    • Only supports TLS 1.2 or newer; HTTP is not enabled by default
    • Options for no logging and no metrics
    • Support for on-disk XChaCha20 encryption with ephemeral key generation
  • Supports an internal LFU, LRU, or a redis instance for in-memory caching

Building

cargo build
cargo test

You may need to set a client secret, see Configuration for more information.

Migration

Migration from the official client was made to be as painless as possible. There are caveats though:

  • If you ever want to return to using the official client, you will need to clear your cache.
  • As this is an unofficial client implementation, the only support you can probably get is from me.

Otherwise, the steps to migration is easy:

  1. Place the binary in the same folder as your images folder and settings.yaml.
  2. Rename images to cache.

Client implementation

This client follows a secure-first approach. As such, your statistics may report a ever-so-slightly higher-than-average failure rate. Specifically, this client choses to:

  • Not support TLS 1.1 or 1.0, which would be a primary source of incompatibility.
  • Not provide a server identification string in the header of served requests.
  • HTTPS by enabled by default, HTTP is provided (and unsupported).

That being said, this client should be backwards compatibility with the official client data and config. That means you should be able to replace the binary and preserve all your settings and cache.

Installation

Either build it from source or run cargo install mangadex-home.

Configuration

Most configuration options can be either provided on the command line or sourced from a file named settings.yaml from the directory you ran the command from, which will be created on first run.

Note that the client secret (CLIENT_SECRET) is the only configuration option that can only can be provided from the environment, an .env file, or the settings.yaml file. In other words, you cannot provide this value from the command line.

Special thanks

This project could not have been completed without the assistance of the following:

Development Assistance (Alphabetical Order)

  • carbotaniuman#6974
  • LFlair#1337
  • Plykiya#1738
  • Tristan 9#6752
  • The Rust Discord community

Beta testers

  • NigelVH#7162

If using the geo IP logging feature, then this product includes GeoLite2 data created by MaxMind, available from https://www.maxmind.com.