Skip to content

eBook server supporting ePub and Authentication

Notifications You must be signed in to change notification settings

x3m444/readimension

 
 

Repository files navigation

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

About

eBook server supporting ePub and Authentication

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 40.3%
  • HTML 23.4%
  • CSS 18.0%
  • JavaScript 17.9%
  • Makefile 0.4%