Skip to content

Getting Started

OpenBooks provides a convenient user interface over IRC Highway's #ebook channel. It streamlines the process of connecting, searching for, and downloading books.

OpenBooks does not host any content, think of it as a single-purpose IRC client.

There are 2 modes of operation; CLI or Server.

The majority of users will want to check out the Server Mode where you search and download via a web interface in your browser. This allows you to self-host OpenBooks without having to install it on every device.

If you'd prefer to use OpenBooks from your terminal, check out CLI Mode.

Docker

docker run -p 8080:80 evanbuss/openbooks

Basic configuration that exposes the web interface on http://localhost:8080 and saves all files to an anonymous volume.

docker run -p 8080:80 -v ~/Downloads/openbooks:/books evanbuss/openbooks --persist

More advanced configuration that exposes the web interface on http://localhost:8080 and persists all eBook files to the mounted volume at ~/Downloads/openbooks.

For more information see the docker guide.

Executable

  1. Download the latest release for your platform from the releases page.

  2. Execute it from your terminal in Server (./openbooks server) or CLI (./openbooks cli) mode.

  3. Linux users may have to run chmod +x [binary name] to make it executable

For more information see the executable guide.