Update readme and gitignore
This commit is contained in:
@@ -12,3 +12,5 @@
|
||||
# Built Visual Studio Code Extensions
|
||||
*.vsix
|
||||
|
||||
*.swp
|
||||
.DS_Store
|
||||
|
||||
@@ -1,2 +1,29 @@
|
||||
# seerr
|
||||
# Seerr
|
||||
|
||||
Seerr manages media requests and connects users with supported media servers and automation services.
|
||||
|
||||
## Deployment layout
|
||||
|
||||
- **Compose:** `/srv/docker/seerr/docker-compose.yml`
|
||||
- **Static configuration/source:** no additional mounted static configuration
|
||||
- **Non-secret environment:** log level `debug` and timezone `Etc/UTC` are declared inline in Compose
|
||||
- **Secrets:** no separately mounted secret file; integration credentials and tokens are stored inside protected
|
||||
application-managed settings
|
||||
- **NVMe application state:** `/srv/appdata/seerr/config`
|
||||
- **Bulk HDD data:** none
|
||||
- **Other mounts:** none
|
||||
|
||||
Secrets are never committed to this repository. Seerr stores confidential
|
||||
settings, integration credentials, and tokens inside its protected application
|
||||
state; the complete state directory and its backups must be treated as
|
||||
sensitive.
|
||||
|
||||
## Dependencies and recovery
|
||||
|
||||
- **Networks/dependencies:** Seerr uses the external `npm_proxy` network at `192.168.97.15`; media-server,
|
||||
Radarr, and Sonarr integrations are application-level dependencies stored in protected state
|
||||
- **Back up:** `/srv/appdata/seerr/config`, including settings, database, users, request history, and
|
||||
integration configuration
|
||||
- **Re-creatable:** the Seerr container image; generated logs and caches within application state are disposable
|
||||
but are not mounted separately
|
||||
|
||||
|
||||
Reference in New Issue
Block a user