{"repo":"vanadium23/kompanion","free":true,"listed":false,"github":"https://github.com/vanadium23/kompanion","clone":"git clone https://github.com/vanadium23/kompanion.git","description":"a self hosted backend for bookworms, tightly coupled with KOReader","language":"Go","stars":128,"topics":["ebook","ebook-library","koreader-sync","self-hosted"],"license":"MIT","category":"self-hosted-apps","readme_excerpt":"KOmpanion - bookshelf companion for KOreader KOmpanion is a minimalistic library web application, that tightly coupled to KOReader features. Main features are: - upload and view your bookshelf - OPDS to download books - KOReader sync progress API - KOReader book stats via WebDAV What KOmpanion is NOT about: - web interface for book reading (just install KOReader) - converter between formats (I don't want to do another calibre) Why KOReader for all? KOReader is the best available reader on the market (personal opinion). Features, that can buy you in: - sync progress between tablet, phone and ebook - extensive stats for book reading: total time, time per page, estimates Installation Railway (preferred) Docker 1. you need a postgresql instance 2. run docker run -e KOMPANION PG URL=postgres://... -e KOMPANION AUTH PASSWORD=password -e KOMPANION AUTH USERNAME=username kompanion , where you pass pg url and admin username and password to init Pre-compiled binary 1. download archive with latest binary from Releases page 2. run KOMPANION PG URL=postgres://... -e KOMPANION AUTH PASSWORD=password -e KOMPANION AUTH USERNAME=username ./kompanion , it will start server with provided postgresql and admin credentials Configuration - KOMPANION AUTH USERNAME - required for setup - KOMPANION AUTH PASSWORD - required for setup - KOMPANION AUTH STORAGE - postgres or memory (default: postgres) - KOMPANION HTTP PORT - port for service (default: 8080) - KOMPANION LOG LEVEL - debug, info, error (defa","default_branch":null,"files":null,"tree":[],"storefront":"/r/vanadium23","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/vanadium23/kompanion/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}