readimension

readimension is a epub web service provides both file management and browser reader.

Features

• Book format: epub
• File Explorer like File Management
• Responsive web interface
• Web based epub reader(satorumurmur/bibi)

Conf

{
    "production": {
        "addr": "127.0.0.1",
        "port": "10086",
        "serve_static": false,
        "session_secret": "session_secret",
        "emails": ["[email protected]"],
        "google_analytics": "UA-****-*"
    },
    "development": {
        "addr": "127.0.0.1",
        "port": "10086",
        "serve_static": true,
        "session_secret": "session_secret",
        "emails": ["[email protected]"],
        "google_analytics": "UA-****-*"
    }
}

Docker Usage

git clone https://github.com/kyicy/readimension.git
cd readimension
docker build  -t readimension .

## try it out with default conf
docker run --rm -it -p 10086:10086 readimension

## sharing
## suppose there's a config.json at $(pwd)/test
docker run --rm -it -p 10086:10086 -v $(pwd)/test:/data/readimension readimension

Usage

go install github.com/kyicy/readimension@latest

Switch to an working directory where readimension will save data.

Create a configuration file, config.json

Then start the server

readimension --env development --path .

addr and port defines which ip and port the web service shall listen to. emails contains an array of emails are allowed to register users.

readimension will generate three folders {uploads, covers, books} and one database file readimension.db.

In production environment, it's preferred to set serve_static to false and set up a nginx instance to serve static files (covers and books).

Then, just enjoy reading.

Screenshots

Desktop

Mobile