eBook server supporting ePub and Authentication
Switch branches/tags
Nothing to show
Clone or download
Latest commit db6637a Dec 14, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bib add serve_static option Oct 21, 2018
middleware remove minify Oct 19, 2018
model add serve_static option Oct 21, 2018
public fix lists view css Oct 29, 2018
route fix bibi auth Dec 14, 2018
screenshots update readme Oct 18, 2018
utility add serve_static option Oct 21, 2018
.gitignore remove mysql and redis, use sqlite instead. Use emails whitelist for … Oct 18, 2018
Makefile cover resize Oct 19, 2018
README.md Update README.md Nov 14, 2018
a_main-packr.go fix lists view css Oct 29, 2018
app.go fix packr deprecation Dec 14, 2018
config.sample.json autotls Oct 19, 2018
main.go add serve_static option Oct 21, 2018

README.md

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)

Usage

Download the binary file from release page

or go get -v github.com/kyicy/readimension

Switch to an working directory where readimension will save data.

Create a configuration file, config.json

{
    "production": {
        "addr": "0.0.0.0",
        "port": "10086",
        "serve_static": false,
        "session_secret": "",
        "emails": ["example@example.com"],
        "google_analytics": ""
    },
    "development": {
        "addr": "0.0.0.0",
        "port": "10086",
        "serve_static": true,
        "session_secret": "",
        "emails": ["example@example.com"],
        "google_analytics": ""
    }
}

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