mirror of
https://github.com/calibrain/shelfmark.git
synced 2026-11-14 09:08:25 +00:00
splitsec2
20848a8774
These are the leftovers from the docs check, the fixes that did not belong in the other three. Claude did the comparison and wrote the changes here too, so I would still like a human look before it merges. The one new piece of prose worth a read is `troubleshooting.md`. It was a TODO page that two other pages link to, so I filled it with only what I could confirm in the code: where the logs go, `LOG_LEVEL`, the `DEBUG=true` bundle from the bug report template, and reporting an issue. Happy to drop it back to a stub if you would rather write that one yourself. - `configuration.md`, `custom-scripts.md`, `users-and-requests.md`: Booklore is Grimmory in the UI now. The stored mode value is still `booklore`, and the custom script doc says so. The hardlink heading now matches the "Hardlink Book Torrents" and "Hardlink Audiobook Torrents" checkboxes. - `custom-scripts.md`: the email output runs scripts too (`phase=post_email`, `output.mode=email`, details under `output.details.email`). It was missing from the phase list. - `users-and-requests.md`: a delivery that fails with no retry available goes back to pending on its own, and the admin reopen action is for rejected requests. The page said an admin reopens a failed delivery. Also noted that rules cannot use Request Book. - `hardcover-sync.md`: added the missing `AUTO_DOWNLOAD_AUDIOBOOK_MIN_SIZE_PERCENT` row and a sentence in the ranking paragraph. - `api-access.md`: an admin session also reads `/api/stats`, and what the 403 says. - `installation.md`: points at the Lite, Tor and WireGuard variants. Docs only, no code touched.
35 lines
1.1 KiB
Markdown
35 lines
1.1 KiB
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
|
|
- The Lite image and the Tor and WireGuard variants have their own compose files, described under Docker Variants in the [README](../readme.md)
|