Portainer Templates logo

Portainer Templates

Ghostfolio Ghostfolio

Stack

Other

Ghostfolio is a privacy-first, open source dashboard for your personal finances. Break down your asset allocation, know your net worth and make solid, data-driven investment decisions.

Configuration

Type
Compose
Platform
linux
Env vars
POSTGRES_USER=ghostfolio_usrPOSTGRES_PASSWORD=r2sp88fzvjnj9e24maycjv6e7kukj8wurcmtPOSTGRES_DB=ghostfolio_dbALPHA_VANTAGE_API_KEY=ACCESS_TOKEN_SALT=4574k48a355hkcbew7h69xazz694bd32xmzeJWT_SECRET_KEY=8k8zvx2krrrh7qcsqnsn73e5bvfesupy3b75
Restart
unless-stopped
Source
Repo

Template by novaspirit·Source

Notes

Template created by Pi-Hosted Series
Check our Github page: https://github.com/pi-hosted/pi-hosted

Official Webpage: https://ghostfol.io/
Official Docker Documentation: https://github.com/ghostfolio/ghostfolio#self-hosting


Services

ghostfolio

Configuration

Image
ghostfolio/ghostfolio:latest
Ports
3333:3333
Env vars
DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}?sslmode=preferNODE_ENV=productionREDIS_HOST=redisREDIS_PORT=6379ALPHA_VANTAGE_API_KEY=${ALPHA_VANTAGE_API_KEY}COMPOSE_PROJECT_NAME=ghostfolioACCESS_TOKEN_SALT=${ACCESS_TOKEN_SALT}JWT_SECRET_KEY=${JWT_SECRET_KEY}

Image details

Pulls: 3.1M
User: ghostfolio
Created: Dec 13, 2021
Updated: 15 hours ago
Status: active

postgres

Configuration

Image
postgres:12
Volumes
/var/lib/postgresql/data : postgres
Env vars
POSTGRES_DB=${POSTGRES_DB}POSTGRES_USER=${POSTGRES_USER}POSTGRES_PASSWORD=${POSTGRES_PASSWORD}

Image details

Pulls: 11.2B
User: stackbrew
Created: Jun 05, 2014
Updated: 37 minutes ago
Status: active

redis

Configuration

Image
redis:alpine

Image details

Pulls: 11.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 9 days ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Ghostfolio

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Ghostfolio, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

version: '3.7'
services:
  ghostfolio:
    image: ghostfolio/ghostfolio:latest
    environment:
      DATABASE_URL: postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}?sslmode=prefer
      NODE_ENV: production
      REDIS_HOST: redis
      REDIS_PORT: 6379
      ALPHA_VANTAGE_API_KEY: ${ALPHA_VANTAGE_API_KEY}
      COMPOSE_PROJECT_NAME: ghostfolio
      ACCESS_TOKEN_SALT: ${ACCESS_TOKEN_SALT}
      JWT_SECRET_KEY: ${JWT_SECRET_KEY}
    ports:
      - 3333:3333
    depends_on:
      - postgres

  postgres:
    image: postgres:12
    environment:
      POSTGRES_DB: ${POSTGRES_DB}
      POSTGRES_USER: ${POSTGRES_USER}
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
    volumes:
      - postgres:/var/lib/postgresql/data

  redis:
    image: redis:alpine

volumes:
  postgres:

Or deploy it directly from the source:

git clone https://github.com/pi-hosted/pi-hosted/
cd pi-hosted
docker compose -f stack/ghostfolio.yml up -d

More install options in our documentation.

Container Documentation

ghostfolio Documentation

Open Source Wealth Management Software

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.

Serve Ghostfolio on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying ghostfolio.example.com to http://ghostfolio:3333

Add this to your Caddyfile

ghostfolio.example.com {
	reverse_proxy http://ghostfolio:3333
}

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: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:3333 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :3333
  • Stop the other service, or pick a different host port. In 3333:3333 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:3333. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, ghostfolio can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 3333

Image won't pull

Test the pull directly on the host: docker pull ghostfolio/ghostfolio: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 login to 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 no so 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.

A Compose stack

Ghostfolio 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:

  • ghostfolio runs ghostfolio/ghostfolio:latest, starts after postgres
  • postgres runs postgres:12
  • redis runs redis:alpine

Ports

A port is the door the app answers on. A mapping like 3333:3333 means it's reachable on port 3333 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 3333:3333

Volumes

A volume is where Ghostfolio 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:

  • /var/lib/postgresql/data kept in the postgres volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Ghostfolio takes 11 of them, all with defaults you can leave alone or tweak:

  • DATABASE_URL, defaults to postgresql://POSTGRES_USER:POSTGRES_PASSWORD@postgres:5432/POSTGRES_DB?sslmode=prefer
  • NODE_ENV, defaults to production
  • REDIS_HOST, defaults to redis
  • REDIS_PORT, defaults to 6379
  • ALPHA_VANTAGE_API_KEY, pulled from your own environment
  • COMPOSE_PROJECT_NAME, defaults to ghostfolio
  • ACCESS_TOKEN_SALT, pulled from your own environment
  • JWT_SECRET_KEY, pulled from your own environment
  • POSTGRES_DB, pulled from your own environment
  • POSTGRES_USER, pulled from your own environment
  • POSTGRES_PASSWORD, pulled from your own environment

Restart policy

The restart policy here is unless-stopped, so Docker restarts Ghostfolio 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 ghostfolio) 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 Ghostfolio up. Add the template list to Portainer once, then deploying Ghostfolio is a click rather than a wall of config.