hesinde-sync/README.md

1.2 KiB

Hesinde Sync

A reimplementation of the Koreader Sync Server because I wanted to try poem openapi.

Building

Nix

A nix environment with enabled nix-commands in order to use nix develop.

Run nix develop to be dropped into a shell with everything installed and configured. From there all the usual cargo commands are accessible.

Classic

A recent rust installation is all that is needed.

From there on cargo run and cargo build and so on can be used.

Usage

Usage: hesinde-sync [OPTIONS]

Options:
  -a, --address <ADDRESS>              Address to listen on [env: ADDRESS=] [default: localhost:3030]
  -d, --db-connection <DB_CONNECTION>  From which file to read the database connection string ("-" for stdin) [env: DB_CONNECTION=] [default: -]
  -a, --allow-registering              Whether new users can register [env: ALLOW_REGISTERING=]
  -h, --help                           Print help
  -V, --version                        Print version

The url for koreader is http://<ADDRESS>/api.