oddomatik/actual-simplefin-sync repository overview

⁠actual-simplefin-docker: Dockerize Your Financial Data Sync

⁠Introduction

Welcome to actual-simplefin-sync, a simple Node.js application⁠ crafted with precision by lancepick⁠, improvements from latetedemelon's branch⁠ (and others!) to work with the latest Actual updates, and dockerized by yours truly. This solution is engineered to streamline the synchronization of your financial data between the SimpleFIN Bridge and the Actual Budget Manager, bringing efficiency and ease to your financial management experience.

⁠Features

• Lightweight
• Configurable: Manage sync profiles easily with Docker volumes.
• Profile Support: Run with different profiles for multiple account configurations.
• Background Operation: Once configured, designed to run tasks in the background, suitable for scheduled jobs.

⁠Prerequisites

• Ensure Docker and Docker Compose are installed on your system before you start.
• A paid SimpleFin account and freshly provisioned Setup Token (one for each profile)
• A working Actual installation
• See actual-simplefin-sync⁠ for more understanding of the tool

⁠Quick Start

Use the provided docker-compose.yml file for an easy setup.

⁠Docker Compose Configuration

Here's a basic docker-compose.yml:

version: '3.8'
services:
  actual-simplefin-sync:
    image: oddomatik/actual-simplefin-sync:latest
    stdin_open: true
    tty: true
    volumes:
      - config_volume:/app/config
      # Optional: Uncomment to enable logging
      # - ./logs:/app/logs

volumes:
  config_volume:
    name: ${PROFILE_NAME:-actual_config}

⁠Automatic Setup

On the first run (for a given profile), the app will automatically execute --setup if no configuration file is found, creating the necessary configuration in the default or specified volume.

⁠Running with Profiles

Specify a PROFILE_NAME for different configurations. If not set, the default (actual_config) is used. Each profile is intended for a budget sync task, such as a bank account transaction record into an actual account.

sudo [PROFILE_NAME=my-budget] docker compose run --rm actual-simplefin-sync

⁠Scheduled Runs

Just start the container normally (optionally with a given PROFILE_NAME env variable) for subsequent runs. It will use the existing configuration from the specified (or default) volume.

⁠Volume Management

Configuration: Stored in config_volume. A new volume is created for each profile. Logs: To persist logs, uncomment the logs volume line in the docker-compose.yml. Support and Contributions For support, issues, or contributions, please visit the GitHub repository⁠.