Skip to content

Commit e4afe49

Browse files
committed
Add admonition to config reference page regarding parse behavior
Even for app-specific sync operations, an entire YAML file must be well-formed. This is because the YAML parser reads the entire file into memory before parsing it. If the file is not well-formed, the parser will raise an error and the sync operation will fail. Fixes #85
1 parent 33d297b commit e4afe49

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/yaml/config-reference/index.mdx

+10
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,16 @@ multiple ways, offering a lot of flexibility:
1616
from the file relevant for the specific service command you specified (e.g. `recyclarr sync
1717
sonarr` will only read the Sonarr config in the file, even if Radarr config is present).
1818

19+
:::caution
20+
21+
Even when running app-specific synchronization (e.g., `recyclarr sync radarr`), the entire
22+
configuration file must be free of syntax errors. While Recyclarr will ignore the configuration
23+
for services not being synced, it still validates the entire YAML file during parsing. This means
24+
errors in any section, even those for services not being synchronized, will cause the command to
25+
fail.
26+
27+
:::
28+
1929
- Use [a `secrets.yml` file](/yaml/secrets-reference.mdx) to keep sensitive values out of your
2030
configuration files. This prevents accidentally sharing api_keys and other sensitive values when
2131
sharing configurations.

0 commit comments

Comments
 (0)