Portainer Templates logo

Portainer Templates

Shadowbroker Shadowbroker

Stack

OSINT

Global Threat Intercept — Real-Time Geospatial Intelligence Platform

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by xneo1·Source

Services

backend

Configuration

Ports
8000:8000
Volumes
/app/data : /portainer/Files/AppData/Config/shadowbroker
Env vars
AIS_API_KEY=${AIS_API_KEY}OPENSKY_CLIENT_ID=${OPENSKY_CLIENT_ID}OPENSKY_CLIENT_SECRET=${OPENSKY_CLIENT_SECRET}LTA_ACCOUNT_KEY=${LTA_ACCOUNT_KEY}
Restart
unless-stopped
Build
[object Object]

frontend

Configuration

Ports
3000:3000
Restart
unless-stopped
Build
[object Object]

Standalone Install

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

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 Shadowbroker, 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.8'

services:
  backend:
    build: 
      context: ./backend
    container_name: shadowbroker-backend
    ports:
      - "8000:8000"
    environment:
      - AIS_API_KEY=${AIS_API_KEY}
      - OPENSKY_CLIENT_ID=${OPENSKY_CLIENT_ID}
      - OPENSKY_CLIENT_SECRET=${OPENSKY_CLIENT_SECRET}
      - LTA_ACCOUNT_KEY=${LTA_ACCOUNT_KEY}
    volumes:
      - /portainer/Files/AppData/Config/shadowbroker:/app/data
    restart: unless-stopped
  frontend:
    build:
      context: ./frontend
      args:
        # Optional: set this to your backend's external URL if using custom ports
        # e.g. http://192.168.1.50:9096 — leave empty to auto-detect from browser
        NEXT_PUBLIC_API_URL: ${NEXT_PUBLIC_API_URL:-}
    container_name: shadowbroker-frontend
    ports:
      - "3000:3000"
    depends_on:
      - backend
    restart: unless-stopped

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/shadowbroker.yml up -d

More install options in our documentation.

Serve Shadowbroker 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 shadowbroker.example.com to http://backend:8000

Add this to your Caddyfile

shadowbroker.example.com {
	reverse_proxy http://backend:8000
}

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:8000 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8000
  • Stop the other service, or pick a different host port. In 8000:8000 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:8000. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, shadowbroker can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8000

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/shadowbroker

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

Shadowbroker is a Compose stack, a set of containers (2 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 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • backend
  • frontend, starts after backend

Ports

A port is the door the app answers on. A mapping like 8000:8000 means it's reachable on port 8000 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8000 in a browser. It opens:

  • 8000:8000, likely the web interface
  • 3000:3000, likely the web interface

Volumes

A volume is where Shadowbroker 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/data from /portainer/Files/AppData/Config/shadowbroker on the host

Environment variables

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

  • AIS_API_KEY, pulled from your own environment
  • OPENSKY_CLIENT_ID, pulled from your own environment
  • OPENSKY_CLIENT_SECRET, pulled from your own environment
  • LTA_ACCOUNT_KEY, pulled from your own environment

Restart policy

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