You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,6 +39,9 @@ If you just want to track your finances and don't care about databases, this is
39
39
40
40
While designed for absolute beginners, this container is intended to keep pace with upstream self-hosting features rather than stripping them out. The goal is straightforward: if upstream exposes a real self-hosting feature, the Unraid wrapper should either support it or document the gap plainly.
41
41
42
+
Some advanced Sure settings are intentionally managed as container environment variables in the Unraid template instead of only through Sure's web UI. When upstream sees one of those env vars, it may disable the matching control in the app and treat the template value as the source of truth. That is expected for this wrapper.
43
+
This wrapper also defaults `SKYLIGHT_ENABLED=false` at the image level (and exposes it in the template) so AIO users are not required to configure upstream Skylight APM.
44
+
42
45
If you click **"Show more settings..."** in the Unraid template, you can customize the system deeply.
43
46
44
47
Read the comprehensive [Power User Guide here](docs/power-user.md) for instructions on how to configure:
@@ -63,6 +66,7 @@ Just make sure `/mnt/user/appdata/sure-aio` is covered by your standard Unraid C
63
66
64
67
-`Sure-AIO` now pins a specific upstream Sure version instead of following the floating `stable` tag.
65
68
- The repo monitors stable upstream Sure tags and opens a PR when a newer stable version is released.
69
+
- Upstream image digest drift is tracked separately so digest-only refreshes do not masquerade as version-bump PRs.
66
70
- Every `main` package publish now ships the exact upstream version tag, an explicit AIO packaging line tag, `latest`, and `sha-<commit>`.
67
71
- Formal wrapper releases follow the upstream version plus an AIO revision, such as `v0.6.8-aio.1`.
68
72
- See the release workflow details in [docs/releases.md](docs/releases.md).
2.**PostHog:** Fill in your `POSTHOG_KEY` and `HOST` to track user analytics.
66
66
3.**Langfuse:** Fill in your `LANGFUSE_HOST`, `PUBLIC_KEY`, and `SECRET_KEY` to chart token usage, latency, and costs of your AI operations.
67
67
4. If you use hosted Langfuse and prefer a region shortcut instead of a full host URL, set `LANGFUSE_REGION` to `us` or `eu`. If `LANGFUSE_HOST` is set, it wins over the region shortcut.
68
+
5.**Skylight APM:**`SKYLIGHT_ENABLED` defaults to `false` in this AIO wrapper (image default + template field) so users do not need any extra external service for normal operation. If you explicitly want Skylight, set `SKYLIGHT_ENABLED=true` and provide `SKYLIGHT_AUTHENTICATION` from your Skylight app settings.
68
69
69
70
---
70
71
@@ -85,6 +86,8 @@ Sure relies on upstream providers for currency exchange rates and stock logos.
85
86
***Paid API Keys (Optional):** If you prefer Twelve Data, add your API key and change **[API] Exchange Rate Provider** and **[API] Securities Provider** to `twelve_data`.
86
87
***Logos:** Provide a **[API] Brandfetch Client ID** to automatically scrape high-res logos for your bank names and merchants.
87
88
***High-res logos:** Set `BRAND_FETCH_HIGH_RES_LOGOS=true` if you want Sure to prefer larger Brandfetch logo assets where available.
89
+
***Important override behavior:** If you set these provider and logo values in the Unraid template, upstream Sure treats them as env overrides and disables the matching controls in the self-hosting UI. In `sure-aio`, that is deliberate: the template is the power-user control plane.
90
+
***Advanced provider tuning:** The template also exposes `TWELVE_DATA_URL`, `YAHOO_FINANCE_URL`, `YAHOO_FINANCE_MAX_RETRIES`, `YAHOO_FINANCE_RETRY_INTERVAL`, and `YAHOO_FINANCE_MIN_REQUEST_INTERVAL` if you need proxying or retry tuning.
88
91
89
92
---
90
93
@@ -100,8 +103,8 @@ To enable Single Sign-On (SSO):
100
103
-`AUTH_JIT_MODE=link_only` if SSO should only link to existing users rather than auto-create them
101
104
-`ALLOWED_OIDC_DOMAINS` to restrict which email domains may auto-create accounts through JIT SSO
102
105
4. Optional button labels/icons are exposed too, along with dedicated Google and GitHub OAuth client fields if you want those providers separately.
103
-
5.Upstream also supports additional named OIDC providers through env patterns like `OIDC_KEYCLOAK_*`or`OIDC_AUTHENTIK_*`. That is practical in raw compose files, but not cleanly representable in a static Unraid CA template. For this wrapper, the default generic OIDC path plus dedicated Google/GitHub options are exposed in the template; anything beyond that is a manual power-user customization.
104
-
6. Upstream also uses `APP_URL` for some advanced SSO flows, especially SAML-style absolute callback and issuer generation. If you are doing advanced auth beyond the normal generic OIDC path, set `APP_URL` to your full external base URL such as `https://finance.example.com`.
106
+
5.The template now also exposes `AUTH_PROVIDERS_SOURCE` plus named multi-provider envs like `OIDC_KEYCLOAK_*`and`OIDC_AUTHENTIK_*` if you want upstream's YAML-based or database-backed multi-provider SSO model.
107
+
6. Upstream also uses `APP_URL` for advanced auth flows, especially absolute callback and issuer generation. If you are doing advanced auth beyond the normal generic OIDC path, set `APP_URL` to your full external base URL such as `https://finance.example.com`.
105
108
106
109
### SMTP Mail Relay (For Password Resets / Reports)
107
110
1. Find the **[Email]** block.
@@ -179,6 +182,45 @@ For most Unraid installs, plain container logs are enough. If you want centraliz
179
182
180
183
---
181
184
185
+
## 12. Sync, Plaid, and Runtime Tuning
186
+
187
+
The template now exposes the main upstream runtime toggles that were previously only obvious in docs or code:
188
+
189
+
1.**Sync scheduling**
190
+
-`AUTO_SYNC_ENABLED`
191
+
-`AUTO_SYNC_TIME`
192
+
-`AUTO_SYNC_TIMEZONE`
193
+
2.**Pending transaction behavior**
194
+
-`SIMPLEFIN_INCLUDE_PENDING`
195
+
-`PLAID_INCLUDE_PENDING`
196
+
- Just like provider selection, these env overrides lock the matching Sync control in Sure's UI when set.
These are all legitimate upstream runtime knobs, but not all of them belong in a beginner walkthrough. They are here because `sure-aio` should expose the real self-hosting surface without forcing users to rebuild the image just to reach it.
221
+
222
+
---
223
+
182
224
## Trial / Subscription Note
183
225
184
226
Upstream `v0.6.9` is supposed to disable subscription and trial gating in self-hosted mode when `SELF_HOSTED=true`. The 45-day trial logic still exists in the codebase, but upstream guards it behind `app_mode != self_hosted`.
Copy file name to clipboardExpand all lines: docs/releases.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
3
3
`sure-aio` uses upstream-version-plus-AIO-revision releases such as `v0.6.8-aio.1`.
4
4
5
+
Stable upstream version monitoring and upstream image digest monitoring are separate concerns. Version bumps should open explicit upstream-update PRs, while digest-only refreshes should flow through normal dependency update automation.
6
+
5
7
## Version format
6
8
7
9
- first wrapper release for upstream `v0.6.8`: `v0.6.8-aio.1`
0 commit comments