Skip to content

Wallos: Open-source, self-hostable personal subscription tracker. Visualize your recurring expenses, manage your budget, and save money.

docs(readme): document AI recommendations (#1293)

Artic0din8cc1f5d6489d
diff --git a/README.md b/README.md
index 77972c3..ea28745 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,7 @@
- [Usage](#usage)
- [Screenshots](#screenshots)
- [OIDC](#oidc)
+- [AI Recommendations](#ai-recommendations)
- [API Documentation](#api-documentation)
- [Contributing](#contributing)
- [Contributors](#contributors)
@@ -58,7 +59,7 @@ Wallos is a powerful, open-source, and self-hostable web application designed to
- Notifications: Wallos supports multiple notification methods (email, discord, pushover, telegram, gotify and webhooks). Get notified about your upcoming payments.
- Multi Language support.
- OIDC with OAuth
-- AI Recommendations with ChatGPT, Gemini or Local Ollama
+- AI Recommendations with ChatGPT, Gemini, OpenRouter, a local Ollama or any OpenAI-compatible API
## Demo
@@ -253,6 +254,26 @@ Wallos blocks webhook, SMTP, and OIDC endpoint URLs that resolve to private/link
Setting the `SSRF_ALLOWLIST` environment variable overrides the database value entirely (same full-override semantics as the `OIDC_*` variables above), so the allowlist can be provisioned on first boot with no manual UI step. It accepts a comma-separated list of hosts/IPs, optionally with a port (e.g. `SSRF_ALLOWLIST=auth.example.com,192.168.1.100:8123`). While set, the Security Settings field in the Admin UI is shown but disabled.
+## AI Recommendations
+
+Wallos can ask an AI model for ways to save money on your subscriptions.
+Each user sets it up under Settings, in the AI Recommendations section: enable it, choose a provider, then select **Test** to load the available models, pick one and save.
+
+| Provider | Needs |
+| --- | --- |
+| ChatGPT | An OpenAI API key |
+| Gemini | A Google AI Studio API key |
+| OpenRouter | An OpenRouter API key |
+| Local Ollama | The Ollama URL, e.g. `http://localhost:11434` |
+| OpenAI Compatible | The API base URL, e.g. `http://localhost:11434/v1`, and an API key if the server requires one |
+
+**Generate Recommendations** runs it on demand; the run schedule can also repeat it weekly or monthly.
+Recommendations are based on your active subscriptions and household members, and appear on the dashboard.
+When AI is enabled with a model saved and the interface language is not English, the categories section of the settings page can also translate category names into that language.
+
+A local Ollama or OpenAI-compatible server on a private address is blocked unless its host is in the [SSRF allowlist](#ssrf-allowlist).
+For any user other than the first (admin) account, the admin also has to enable **Allow standard users to use the Webhook Allowlist** in the Security Settings. The host still has to be in the allowlist; enabling the setting alone is not enough.
+
## API Documentation
Wallos provides a comprehensive API that allows you to interact with the application programmatically. The API documentation is available at [https://api.wallosapp.com/](https://api.wallosapp.com/).