Skip to content

Configuration

Fins1600 edited this page May 11, 2026 · 1 revision

Configuration

Weekaroo stores local settings in JSON files. Private config files are ignored by git so you can keep calendar URLs, notes, tokens, and local preferences out of the public repository.

Calendars

Weekaroo includes a US Holidays calendar by default. Add personal or shared calendars from Settings → Calendars, or edit calendars.json manually.

Example:

[
  {
    "id": "us-holidays",
    "name": "US Holidays",
    "url": "https://www.officeholidays.com/ics/usa",
    "color": "#f59e0b",
    "enabled": true
  },
  {
    "id": "family",
    "name": "Family",
    "url": "https://calendar.example.com/family.ics",
    "color": "#7dd3c7",
    "enabled": true
  }
]

Messages, countdowns, timers, and day notes

Create local config files from examples:

cp family-messages.example.json family-messages.json
cp countdowns.example.json countdowns.json
cp day-notes.example.json day-notes.json

Timers and day notes can also be edited from the dashboard settings UI.

Weather

By default, Weekaroo uses public weather by ZIP/postal code. Weather settings can be edited in Settings → Weather.

WeatherFlow Tempest is optional. If you use it, enter the station ID and token in Settings → Weather. The token is stored server-side in weather-config.json, which is ignored by git.

Optional AI messages

Settings → AI supports OpenRouter or another OpenAI-compatible endpoint.

Recommended secret handling:

export OPENROUTER_API_KEY="your-key"
# or
export DASHBOARD_AI_API_KEY="your-key"

You may also save a key in ai-config.json, but never commit that file.

Clone this wiki locally