actual-ical

A simple application to expose Actual Scheduled Transactions in iCal format.

Features

• Currency display
• Respect schedule weekend configuration
• Realtime updates
• Random URL to make it harder to guess (using the Sync ID)

Usage

Just run the docker image

docker volume create actual-ical

docker run -d -p 3000:3000 \
  -v actual-ical:/app/.actual-cache \
  -e ACTUAL_SERVER=http://actual.example.com \
  -e ACTUAL_MAIN_PASSWORD=mainpassword \
  -e ACTUAL_SYNC_ID=syncid \
  ghcr.io/matheusvellone/actual-ical

Or with docker-compose

services:
  actual-ical:
    image: ghcr.io/matheusvellone/actual-ical
    ports:
      - 3000:3000
    environment:
      ACTUAL_SERVER: http://actual.example.com
      ACTUAL_MAIN_PASSWORD: mainpassword
      ACTUAL_SYNC_ID: syncid
    volumes:
      - actual-ical:/app/.actual-cache

volumes:
  actual-ical:

Then you can access the iCal feed at http://localhost:3000/actual.ics

If SYNC_ID_AS_URL is set to true, the URL will be http://localhost:3000/{ACTUAL_SYNC_ID}.ics

Configuration

All configuration is done through environment variables.

Event template variables

The EVENT_NAME_TEMPLATE and EVENT_DESCRIPTION_TEMPLATE variables control the event title and description respectively. Variables are written as {{variableName}} and will be replaced at render time.

Note: Some variables might not be defined for all events (marked with ⚠️). For example, accountName will only be defined for schedules that belong to an account. If a variable is not defined, it will be replaced with an empty string.

Note 2: Template values are always trimmed, so any leading or trailing whitespace will be removed.

Hosting it publicly

If you want to host this application publicly, you should use SYNC_ID_AS_URL to make the URL random and harder to guess.