Sure
Stack
Personal finance app for keeping your whole net worth in one place, with accounts, investments, budgets, transaction rules, CSV imports and reports, plus an optional AI assistant. A community fork of Maybe Finance. Source: https://github.com/we-promise/sure
Source details
Configuration
TypeComposelinuxSURE_SECRET_KEY_BASE=''SURE_DB_PASSWORD=''SURE_PORT=3400unless-stoppedTemplate by NotAFlightRisk·Source
Report issueNotes
openssl rand -hex 64 for the key base, openssl rand -hex 32 for the database), and keep them the same on every redeploy - the key base also encrypts saved bank and API credentials. Give it a minute on first start while it sets up the database, then open it on port 3400 and pick "create your account". The first account becomes the super admin. Sign-ups stay open after that, and everyone else gets their own separate household, so close them under Settings --> Self-Hosting --> Onboarding, or add SURE_ONBOARDING = closed (or invite_only) to the stack's environment variables and redeploy. Exchange rates and share prices come from Twelve Data with a free key, or switch both to Yahoo Finance (no key) on the same page, and the AI assistant wants an OpenAI-compatible key there too. Bank syncing is optional. A worker container runs imports, syncs and the scheduled jobs. Your data lives in Postgres, in the postgres-data volume, and uploads in sure-storage. Docs: self-hosting with DockerServices
sure
Configuration
Imageghcr.io/we-promise/sure:stable${SURE_PORT:-3400}:3000/rails/storage : sure-storageSECRET_KEY_BASE=${SURE_SECRET_KEY_BASE:?Set a secret key base}SELF_HOSTED=trueRAILS_FORCE_SSL=falseRAILS_ASSUME_SSL=falseONBOARDING_STATE=${SURE_ONBOARDING:-open}DB_HOST=postgresDB_PORT=5432POSTGRES_DB=surePOSTGRES_USER=surePOSTGRES_PASSWORD=${SURE_DB_PASSWORD:?Set a database password}REDIS_URL=redis://redis:6379/1unless-stoppedImage details
worker
Configuration
Imageghcr.io/we-promise/sure:stablebundle,exec,sidekiq/rails/storage : sure-storageSECRET_KEY_BASE=${SURE_SECRET_KEY_BASE:?Set a secret key base}SELF_HOSTED=trueRAILS_FORCE_SSL=falseRAILS_ASSUME_SSL=falseONBOARDING_STATE=${SURE_ONBOARDING:-open}DB_HOST=postgresDB_PORT=5432POSTGRES_DB=surePOSTGRES_USER=surePOSTGRES_PASSWORD=${SURE_DB_PASSWORD:?Set a database password}REDIS_URL=redis://redis:6379/1unless-stoppedImage details
postgres
Configuration
Imagepostgres:16-alpine/var/lib/postgresql/data : postgres-dataPOSTGRES_DB=surePOSTGRES_USER=surePOSTGRES_PASSWORD=${SURE_DB_PASSWORD:?Set a database password}unless-stoppedImage details
redis
Configuration
Imageredis:8-alpine/data : redis-dataunless-stoppedImage details
Standalone Install
Select an install method, to see config/commands for deploying Sure
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select Sure, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
Original stackfile
The compose file this template deploys, straight from its repo:
x-sure-env: &sure-env
SECRET_KEY_BASE: ${SURE_SECRET_KEY_BASE:?Set a secret key base}
SELF_HOSTED: "true"
RAILS_FORCE_SSL: "false"
RAILS_ASSUME_SSL: "false"
ONBOARDING_STATE: ${SURE_ONBOARDING:-open}
DB_HOST: postgres
DB_PORT: "5432"
POSTGRES_DB: sure
POSTGRES_USER: sure
POSTGRES_PASSWORD: ${SURE_DB_PASSWORD:?Set a database password}
REDIS_URL: redis://redis:6379/1
services:
sure:
image: ghcr.io/we-promise/sure:stable
restart: unless-stopped
ports:
- "${SURE_PORT:-3400}:3000"
environment: *sure-env
volumes:
- sure-storage:/rails/storage
depends_on:
postgres:
condition: service_healthy
redis:
condition: service_healthy
worker:
image: ghcr.io/we-promise/sure:stable
restart: unless-stopped
command: ["bundle", "exec", "sidekiq"]
environment: *sure-env
volumes:
- sure-storage:/rails/storage
depends_on:
sure:
condition: service_started
postgres:
image: postgres:16-alpine
restart: unless-stopped
environment:
POSTGRES_DB: sure
POSTGRES_USER: sure
POSTGRES_PASSWORD: ${SURE_DB_PASSWORD:?Set a database password}
volumes:
- postgres-data:/var/lib/postgresql/data
healthcheck:
test: ["CMD-SHELL", "pg_isready -U sure -d sure"]
interval: 10s
timeout: 5s
retries: 5
redis:
image: redis:8-alpine
restart: unless-stopped
volumes:
- redis-data:/data
healthcheck:
test: ["CMD", "redis-cli", "ping"]
interval: 10s
timeout: 5s
retries: 5
volumes:
sure-storage:
postgres-data:
redis-data:
Or deploy it directly from the source:
git clone https://github.com/NotAFlightRisk/portainer-templates-extras
cd portainer-templates-extras
docker compose -f apps/sure/compose.yml up -dMore install options in our documentation, or see we-promise/sure for app-specific guidance.
Container Documentation
postgres Documentation
The PostgreSQL object-relational database system provides reliability and data integrity.
redis Documentation
Redis is the world’s fastest data platform for caching, vector search, and NoSQL databases.
Check the logs first
Nine times out of ten the logs tell you exactly what went wrong.
- In Portainer, go to Containers, click the container, then Logs. Or run
docker logs <container> - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Image won't pull
Test the pull directly on the host: docker pull ghcr.io/we-promise/sure:stable
- "manifest unknown" means the tag no longer exists.
- "toomanyrequests" is the Docker Hub rate limit. Log in with
docker loginto raise it. - "no space left on device" means a full disk. Reclaim space with
docker system prune
"exec format error"
This means the image was built for a different CPU architecture than your server.
- Check yours with
uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.
Container keeps restarting
The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.
- Check the logs right after a restart, the last few lines before it died are the useful ones.
- Get the exit code with
docker inspect <container> --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
Stack won't deploy
Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.
- YAML only accepts spaces for indentation, a single tab breaks the whole file.
Raise an issue
Found something which isn't working as it should? Here's how to report it.
- Bug within the app: Open an issue on we-promise/sure
- Template not working: Open an issue on NotAFlightRisk/portainer-templates-extras
- This website not working: Open an issue on lissy93/portainer-templates
A Compose stack
Sure is a Compose stack, a set of containers (4 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.
The services
This stack is built from 4 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:
surerunsghcr.io/we-promise/sure:stable, starts after postgres, redisworkerrunsghcr.io/we-promise/sure:stable, starts after surepostgresrunspostgres:16-alpineredisrunsredis:8-alpine
Volumes
A volume is where Sure keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:
/rails/storagekept in thesure-storagevolume Docker manages/var/lib/postgresql/datakept in thepostgres-datavolume Docker manages/datakept in theredis-datavolume Docker manages
Environment variables
Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Sure takes 11 of them, and 2 need a value before it'll start properly:
SECRET_KEY_BASE, needs a valueSELF_HOSTED, defaults totrueRAILS_FORCE_SSL, defaults tofalseRAILS_ASSUME_SSL, defaults tofalseONBOARDING_STATE, defaults toopenDB_HOST, defaults topostgresDB_PORT, defaults to5432POSTGRES_DB, defaults tosurePOSTGRES_USER, defaults tosurePOSTGRES_PASSWORD, needs a valueREDIS_URL, defaults toredis://redis:6379/1
Restart policy
The restart policy here is unless-stopped, so Docker restarts Sure after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).
Networking
Portainer puts these services on one shared private network, so they can find each other by name (like sure) while only the ports above are open to you.
Platform
The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.
Open source license
Sure is open source, released under the AGPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Sure up. Add the template list to Portainer once, then deploying Sure is a click rather than a wall of config.