Skip to content

Latest commit

 

History

History
92 lines (55 loc) · 1.77 KB

README.md

File metadata and controls

92 lines (55 loc) · 1.77 KB
Raw

PonyLib v2

Fb2 library with CLI & Web UI.

Setup with docker-compose (recommended)

You need docker & docker-compose.

Create some directory for ponylib. By default, all data will be stored in data/ subdirectory.

Create ponylib.env file from docs/docker-compose/ponylib.env.example and edit it. It's important to choose right options here before the first app run.

Save docs/docker-compose/docker-compose.yml as docker-compose.yml to the same directory. Add paths to your libraries in volumes section.

Run

docker-compose up -d

It needs some time in the first run to init Database & run DB migrations.

Check status: docker-compose ps, docker-compose logs.

Scan books from libraries. For example:

docker-compose exec ponylib ponylib scan /data/lib1
docker-compose exec ponylib ponylib scan /data/lib3.zip
# ...

Also see other ponylib commands:

docker-compose exec ponylib ponylib --help

Setup without docker (advanced)

Requirements

  • PostgreSQL 12+
  • Go 1.17+

Init DB

Setup PostgreSQL 12+, then

su - postgres

createuser -P ponylib
# define password

createdb -O ponylib ponylib

Build

./build.sh

Usage

DATABASE_URL="postgres://localhost:5432/ponylib?user=ponylib&password=password" FTS_LANGUAGE=english bin/ponylib --help

Additional Tools

ponylib-parser

Parse fb2 files & display metadata. Can be used separately.

Support recursive directory scan, follow symlinks.

Usage:

ponylib-parser FILE_OR_DIR [FILE_OR_DIR]

Obsolete python + django based version