SparkyFitness
Stack
Fitness tracker for food, exercise, water, sleep, fasting, mood and body measurements, with goals, long-term reports and family sharing, plus sync from phone health apps, Fitbit, Strava and more. Source: https://github.com/CodeWithCJ/SparkyFitness
Source details
Configuration
TypeComposelinuxSPARKYFITNESS_URL=''SPARKYFITNESS_ENCRYPTION_KEY=''SPARKYFITNESS_AUTH_SECRET=''SPARKYFITNESS_DB_PASSWORD=''SPARKYFITNESS_ADMIN_EMAIL=''SPARKYFITNESS_PORT=3004unless-stoppedTemplate by NotAFlightRisk·Source
Report issueNotes
http://192.168.1.20:3004: the port you're using, and no slash at the end. SparkyFitness only accepts logins from that address, so if it's wrong the page still loads but signing up or logging in fails with Invalid origin. To fix it, change the address in the stack's environment variables and redeploy. Don't change the encryption key or auth secret once it's running: a new key can't read the API keys you've saved, and a new secret logs everyone out and locks out anyone using two-factor. The first start takes a minute or so. Then open it and sign up, with the admin email if you set one, since that account gets the admin panel. Anyone who can reach it can sign up too, so once everyone's in, add SPARKYFITNESS_DISABLE_SIGNUP = true to the stack's environment variables and redeploy. Food search works straight away through Open Food Facts and a few other free databases. The server fetches news from the project's GitHub, and checks there for new releases unless you turn off Check for New Releases in the admin panel. Everything you log lives in Postgres, in the sparkyfitness-db volume, with photos in sparkyfitness-uploads and backups from the admin panel in sparkyfitness-backup. Docs: codewithcj.github.io/SparkyFitnessServices
sparkyfitness-frontend
Configuration
Imagecodewithcj/sparkyfitness:latest${SPARKYFITNESS_PORT:-3004}:80SPARKY_FITNESS_SERVER_HOST=sparkyfitness-serverSPARKY_FITNESS_SERVER_PORT=3010unless-stoppedImage details
sparkyfitness-server
Configuration
Imagecodewithcj/sparkyfitness_server:latest/app/SparkyFitnessServer/uploads : sparkyfitness-uploads/app/SparkyFitnessServer/backup : sparkyfitness-backupSPARKY_FITNESS_FRONTEND_URL=${SPARKYFITNESS_URL:?Set the address you'll open it on}SPARKY_FITNESS_API_ENCRYPTION_KEY=${SPARKYFITNESS_ENCRYPTION_KEY:?Set an encryption key}BETTER_AUTH_SECRET=${SPARKYFITNESS_AUTH_SECRET:?Set an auth secret}SPARKY_FITNESS_ADMIN_EMAIL=${SPARKYFITNESS_ADMIN_EMAIL:-}SPARKY_FITNESS_DISABLE_SIGNUP=${SPARKYFITNESS_DISABLE_SIGNUP:-false}SPARKY_FITNESS_DB_HOST=sparkyfitness-dbSPARKY_FITNESS_DB_NAME=sparkyfitness_dbSPARKY_FITNESS_DB_USER=sparkySPARKY_FITNESS_DB_PASSWORD=${SPARKYFITNESS_DB_PASSWORD:?Set a database password}unless-stoppedImage details
sparkyfitness-db
Configuration
Imagepostgres:18-alpine/var/lib/postgresql : sparkyfitness-dbPOSTGRES_DB=sparkyfitness_dbPOSTGRES_USER=sparkyPOSTGRES_PASSWORD=${SPARKYFITNESS_DB_PASSWORD:?Set a database password}unless-stoppedImage details
Standalone Install
Select an install method, to see config/commands for deploying SparkyFitness
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 SparkyFitness, 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:
services:
sparkyfitness-frontend:
image: codewithcj/sparkyfitness:latest
restart: unless-stopped
ports:
- "${SPARKYFITNESS_PORT:-3004}:80"
environment:
SPARKY_FITNESS_SERVER_HOST: sparkyfitness-server
SPARKY_FITNESS_SERVER_PORT: 3010
depends_on:
sparkyfitness-server:
condition: service_healthy
sparkyfitness-server:
image: codewithcj/sparkyfitness_server:latest
restart: unless-stopped
environment:
SPARKY_FITNESS_FRONTEND_URL: ${SPARKYFITNESS_URL:?Set the address you'll open it on}
SPARKY_FITNESS_API_ENCRYPTION_KEY: ${SPARKYFITNESS_ENCRYPTION_KEY:?Set an encryption key}
BETTER_AUTH_SECRET: ${SPARKYFITNESS_AUTH_SECRET:?Set an auth secret}
SPARKY_FITNESS_ADMIN_EMAIL: ${SPARKYFITNESS_ADMIN_EMAIL:-}
SPARKY_FITNESS_DISABLE_SIGNUP: ${SPARKYFITNESS_DISABLE_SIGNUP:-false}
SPARKY_FITNESS_DB_HOST: sparkyfitness-db
SPARKY_FITNESS_DB_NAME: sparkyfitness_db
SPARKY_FITNESS_DB_USER: sparky
SPARKY_FITNESS_DB_PASSWORD: ${SPARKYFITNESS_DB_PASSWORD:?Set a database password}
volumes:
- sparkyfitness-uploads:/app/SparkyFitnessServer/uploads
- sparkyfitness-backup:/app/SparkyFitnessServer/backup
healthcheck:
start_period: 3m
depends_on:
sparkyfitness-db:
condition: service_healthy
sparkyfitness-db:
image: postgres:18-alpine
restart: unless-stopped
environment:
POSTGRES_DB: sparkyfitness_db
POSTGRES_USER: sparky
POSTGRES_PASSWORD: ${SPARKYFITNESS_DB_PASSWORD:?Set a database password}
volumes:
- sparkyfitness-db:/var/lib/postgresql
healthcheck:
test: ["CMD-SHELL", "pg_isready -U sparky -d sparkyfitness_db"]
interval: 10s
timeout: 5s
retries: 10
volumes:
sparkyfitness-uploads:
sparkyfitness-backup:
sparkyfitness-db:
Or deploy it directly from the source:
git clone https://github.com/NotAFlightRisk/portainer-templates-extras
cd portainer-templates-extras
docker compose -f apps/sparkyfitness/compose.yml up -dMore install options in our documentation, or see CodeWithCJ/SparkyFitness for app-specific guidance.
Container Documentation
sparkyfitness-db Documentation
The PostgreSQL object-relational database system provides reliability and data integrity.
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 codewithcj/sparkyfitness:latest
- "manifest unknown" means the tag no longer exists. This template uses
latest, so try pinning a specific version instead. - "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 CodeWithCJ/SparkyFitness
- 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
SparkyFitness is a Compose stack, a set of containers (3 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 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:
sparkyfitness-frontendrunscodewithcj/sparkyfitness:latest, starts after sparkyfitness-serversparkyfitness-serverrunscodewithcj/sparkyfitness_server:latest, starts after sparkyfitness-dbsparkyfitness-dbrunspostgres:18-alpine
Volumes
A volume is where SparkyFitness 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:
/app/SparkyFitnessServer/uploadskept in thesparkyfitness-uploadsvolume Docker manages/app/SparkyFitnessServer/backupkept in thesparkyfitness-backupvolume Docker manages/var/lib/postgresqlkept in thesparkyfitness-dbvolume Docker manages
Environment variables
Environment variables are the settings you hand over when you deploy, things like a password or a timezone. SparkyFitness takes 14 of them, and 5 need a value before it'll start properly:
SPARKY_FITNESS_SERVER_HOST, defaults tosparkyfitness-serverSPARKY_FITNESS_SERVER_PORT, defaults to3010SPARKY_FITNESS_FRONTEND_URL, needs a valueSPARKY_FITNESS_API_ENCRYPTION_KEY, needs a valueBETTER_AUTH_SECRET, needs a valueSPARKY_FITNESS_ADMIN_EMAIL, pulled from your own environmentSPARKY_FITNESS_DISABLE_SIGNUP, defaults tofalseSPARKY_FITNESS_DB_HOST, defaults tosparkyfitness-dbSPARKY_FITNESS_DB_NAME, defaults tosparkyfitness_dbSPARKY_FITNESS_DB_USER, defaults tosparkySPARKY_FITNESS_DB_PASSWORD, needs a valuePOSTGRES_DB, defaults tosparkyfitness_dbPOSTGRES_USER, defaults tosparkyPOSTGRES_PASSWORD, needs a value
Restart policy
The restart policy here is unless-stopped, so Docker restarts SparkyFitness 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 sparkyfitness-frontend) 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.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set SparkyFitness up. Add the template list to Portainer once, then deploying SparkyFitness is a click rather than a wall of config.