mirror of
https://github.com/calibrain/shelfmark.git
synced 2026-06-11 14:54:34 -04:00
e35b4c47a7
- 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
34 lines
964 B
Markdown
34 lines
964 B
Markdown
# Installation
|
|
|
|
Shelfmark is typically deployed with Docker Compose.
|
|
|
|
## Quick Start
|
|
|
|
1. Download the compose file from the repository:
|
|
|
|
```bash
|
|
curl -O https://raw.githubusercontent.com/calibrain/shelfmark/main/compose/docker-compose.yml
|
|
```
|
|
|
|
2. Start the service:
|
|
|
|
```bash
|
|
docker compose up -d
|
|
```
|
|
|
|
3. Open `http://localhost:8084`
|
|
|
|
4. Configure the sources, metadata providers, and delivery settings you want to use
|
|
|
|
## Next Steps
|
|
|
|
- For volume and path setup, see [Directory and Volume Setup](configuration.md)
|
|
- For environment-based setup, see [Environment Variables](environment-variables.md)
|
|
- For authentication and user management, see [Users & Requests](users-and-requests.md) and [OIDC](oidc.md)
|
|
|
|
## 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
|