mirror/shelfmark

mirror of https://github.com/calibrain/shelfmark.git synced 2026-06-11 14:54:34 -04:00

Files

Alex e35b4c47a7 Direct source refactor (#895 )

- Updated mirror selection
- Removed built-in mirror options, users must provide their own
configurations
- Set Universal search to default, added ability to disable direct
source
- Updated documentation
- Updated makefile

2026-04-15 18:50:13 +01:00

964 B

Raw Blame History

Installation

Shelfmark is typically deployed with Docker Compose.

Quick Start

Download the compose file from the repository:

curl -O https://raw.githubusercontent.com/calibrain/shelfmark/main/compose/docker-compose.yml

Start the service:

docker compose up -d

Open http://localhost:8084
Configure the sources, metadata providers, and delivery settings you want to use

Next Steps

For volume and path setup, see Directory and Volume Setup
For environment-based setup, see Environment Variables
For authentication and user management, see Users & Requests and OIDC

Notes

Universal search is the default mode for new installs
Direct Download is optional and must be enabled and configured before it can be used
Torrent and usenet setups require matching download paths between Shelfmark and your download client