Portainer Templates logo

Portainer Templates

Ghostfolio Ghostfolio

Stack

Finance

Ghostfolio is an open source wealth management software built with web technology.

Configuration

Type
Compose
Platform
linux
Ports
3663:80/tcp
Restart
always
Source

Template by xneo1·Source

Services

ghostfolio

Configuration

Image
ghostfolio/ghostfolio:latest
Ports
3443:3333
Env vars
DATABASE_URL=postgresql://user:postgrespwd@postgres:5432/ghostfolio-db?sslmode=preferREDIS_HOST=redisREDIS_PASSWORD=${REDIS_PASSWORD}ACCESS_TOKEN_SALT=bvnbvnbcdfbdrfALPHA_VANTAGE_API_KEY=JWT_SECRET_KEY=szvbt45rtfsg5rtgf

Image details

Pulls: 3.4M
User: ghostfolio
Created: Dec 13, 2021
Updated: 1 day ago
Status: active

postgres

Configuration

Image
postgres:12
Volumes
/var/lib/postgresql/data : postgres
Env vars
POSTGRES_DB=ghostfolio-dbPOSTGRES_USER=userPOSTGRES_PASSWORD=postgrespwd

Image details

Pulls: 11.7B
User: stackbrew
Created: Jun 05, 2014
Updated: 1 day ago
Status: active

redis

Configuration

Image
redis:alpine
Env vars
REDIS_HOST=127.0.0.1REDIS_PORT=6379REDIS_PASSWORD=redispwd

Image details

Pulls: 11.4B
User: stackbrew
Created: Jun 05, 2014
Updated: 17 hours 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:

services:
  ghostfolio:
    image: ghostfolio/ghostfolio:latest
    environment:
      DATABASE_URL: postgresql://user:postgrespwd@postgres:5432/ghostfolio-db?sslmode=prefer
      REDIS_HOST: 'redis'
      REDIS_PASSWORD: ${REDIS_PASSWORD}
      ACCESS_TOKEN_SALT: bvnbvnbcdfbdrf
      ALPHA_VANTAGE_API_KEY:
      JWT_SECRET_KEY: szvbt45rtfsg5rtgf
    ports:
      - 3443:3333
  postgres:
    image: postgres:12
    environment:
      POSTGRES_DB: ghostfolio-db
      POSTGRES_USER: user
      POSTGRES_PASSWORD: postgrespwd
    volumes:
      - postgres:/var/lib/postgresql/data

  redis:
    image: 'redis:alpine'
    environment:
      REDIS_HOST: 127.0.0.1
      REDIS_PORT: 6379
      REDIS_PASSWORD: redispwd

volumes:
  postgres:

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/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:3443 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :3443
  • Stop the other service, or pick a different host port. In 3443: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:3443. 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 3443

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 always 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.

Required settings are blank

ALPHA_VANTAGE_API_KEY has no default value, and Ghostfolio may crash or misbehave if left empty.

  • Fill it in on the deploy screen before hitting deploy.

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
  • postgres runs postgres:12
  • redis runs redis:alpine

Ports

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

  • 3443: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 10 of them, and one needs a value before it'll start properly:

  • DATABASE_URL, defaults to postgresql://user:postgrespwd@postgres:5432/ghostfolio-db?sslmode=prefer
  • REDIS_HOST, defaults to 127.0.0.1
  • REDIS_PASSWORD, defaults to redispwd
  • ACCESS_TOKEN_SALT, defaults to bvnbvnbcdfbdrf
  • ALPHA_VANTAGE_API_KEY, needs a value
  • JWT_SECRET_KEY, defaults to szvbt45rtfsg5rtgf
  • POSTGRES_DB, defaults to ghostfolio-db
  • POSTGRES_USER, defaults to user
  • POSTGRES_PASSWORD, defaults to postgrespwd
  • REDIS_PORT, defaults to 6379

Restart policy

The restart policy here is always, so Docker brings Ghostfolio back up after a crash and again when the server reboots. Good for anything you want running around the clock. 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.