Skip to content

Commit f1642c5

Browse files
committed
docs: update readme
1 parent c62f26b commit f1642c5

File tree

1 file changed

+93
-2
lines changed

1 file changed

+93
-2
lines changed

README.md

+93-2
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ Possible ideas:
6363
- [ ] Plain docker
6464
- [ ] Kubernetes
6565
- [ ] Simple Config validation
66+
- [ ] Custom recyclarr templates?
67+
- [ ] Lets say you want the same template but with a different name
6668
6769
## Development
6870
@@ -90,15 +92,15 @@ Optional:
9092

9193
### Docker
9294

93-
`docker run --rm -v ./:/app/config configarr:test`
95+
`docker run --rm -v ./:/app/config ghcr.io/raydak-labs/configarr:work`
9496

9597
### Docker-compose
9698

9799
```yml
98100
99101
services:
100102
configarr:
101-
image: configarr:test
103+
image: ghcr.io/raydak-labs/configarr:work
102104
build: .
103105
environment:
104106
- PUID=1000
@@ -111,3 +113,92 @@ services:
111113
```
112114

113115
### Kubernetes
116+
117+
Example how to run `CronJob` which will regulary sync your configs.
118+
119+
```yml
120+
---
121+
apiVersion: batch/v1
122+
kind: CronJob
123+
metadata:
124+
name: configarr
125+
spec:
126+
schedule: "0 * * * *"
127+
successfulJobsHistoryLimit: 1
128+
failedJobsHistoryLimit: 1
129+
jobTemplate:
130+
spec:
131+
template:
132+
spec:
133+
containers:
134+
- name: configarr
135+
image: ghcr.io/raydak-labs/configarr:work
136+
imagePullPolicy: Always
137+
envFrom:
138+
- configMapRef:
139+
name: common-deployment-environment
140+
volumeMounts:
141+
- mountPath: /app/repos # Cache repositories
142+
name: app-data
143+
subPath: configarr-repos
144+
- name: config-volume # Mount specifc config
145+
mountPath: /app/config/config.yml
146+
subPath: config.yml
147+
- name: secret-volume
148+
mountPath: /app/config/secrets.yml # Mount secrets
149+
subPath: secrets.yml
150+
volumes:
151+
- name: app-data
152+
persistentVolumeClaim:
153+
claimName: media-app-data
154+
- name: config-volume
155+
configMap:
156+
name: configarr
157+
- name: secret-volume
158+
secret:
159+
secretName: configarr
160+
restartPolicy: Never
161+
---
162+
apiVersion: v1
163+
kind: Secret
164+
metadata:
165+
name: configarr
166+
type: Opaque
167+
stringData:
168+
secrets.yml: |
169+
SONARR_API_KEY: "{{ configarr.sonarrApiKey }}"
170+
---
171+
apiVersion: v1
172+
kind: ConfigMap
173+
metadata:
174+
name: configarr
175+
data:
176+
config.yml: |
177+
trashGuideUrl: https://github.com/TRaSH-Guides/Guides
178+
recyclarrConfigUrl: https://github.com/recyclarr/config-templates
179+
180+
sonarr:
181+
series:
182+
# Set the URL/API Key to your actual instance
183+
base_url: http://sonarr:8989
184+
api_key: !secret SONARR_API_KEY
185+
186+
# Quality definitions from the guide to sync to Sonarr. Choices: series, anime
187+
quality_definition:
188+
type: series
189+
190+
include:
191+
# Comment out any of the following includes to disable them
192+
#### WEB-1080p
193+
- template: sonarr-quality-definition-series
194+
- template: sonarr-v4-quality-profile-web-1080p
195+
- template: sonarr-v4-custom-formats-web-1080p
196+
197+
#### WEB-2160p
198+
- template: sonarr-v4-quality-profile-web-2160p
199+
- template: sonarr-v4-custom-formats-web-2160p
200+
201+
# Custom Formats: https://recyclarr.dev/wiki/yaml/config-reference/custom-formats/
202+
custom_formats: []
203+
radarr: {}
204+
```

0 commit comments

Comments
 (0)