Rackula
Plan your rack layout. Drag your devices in, move them around, export it. It runs in your browser. You can close the tab whenever you want
Services
rackula
Configuration
Imageghcr.io/rackulalives/rackula:latest8383:8080API_HOST=rackula-apiAPI_PORT=3001RACKULA_LISTEN_PORT=8080API_WRITE_TOKEN=${RACKULA_API_WRITE_TOKEN:-}RACKULA_AUTH_MODE=${RACKULA_AUTH_MODE:-none}RACKULA_ENABLE_IPV6=${RACKULA_ENABLE_IPV6:-auto}NGINX_RESOLVER=127.0.0.11alwaysrackula-api
Configuration
Imageghcr.io/rackulalives/rackula-api:latest/data : /portainer/Files/AppData/Config/rackula/dataDATA_DIR=/dataRACKULA_API_PORT=3001CORS_ORIGIN=${CORS_ORIGIN:-http://localhost:8383}RACKULA_API_WRITE_TOKEN=${RACKULA_API_WRITE_TOKEN:-}RACKULA_AUTH_MODE=${RACKULA_AUTH_MODE:-none}RACKULA_AUTH_SESSION_SECRET=${RACKULA_AUTH_SESSION_SECRET:-}RACKULA_AUTH_SESSION_MAX_AGE_SECONDS=${RACKULA_AUTH_SESSION_MAX_AGE_SECONDS:-43200}RACKULA_AUTH_SESSION_IDLE_TIMEOUT_SECONDS=${RACKULA_AUTH_SESSION_IDLE_TIMEOUT_SECONDS:-1800}RACKULA_AUTH_SESSION_GENERATION=${RACKULA_AUTH_SESSION_GENERATION:-0}RACKULA_AUTH_SESSION_COOKIE_SAMESITE=${RACKULA_AUTH_SESSION_COOKIE_SAMESITE:-Lax}RACKULA_AUTH_SESSION_COOKIE_SECURE=${RACKULA_AUTH_SESSION_COOKIE_SECURE:-true}RACKULA_AUTH_CSRF_PROTECTION=${RACKULA_AUTH_CSRF_PROTECTION:-true}ALLOW_INSECURE_CORS=${ALLOW_INSECURE_CORS:-false}alwaysInstallation
- 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 the app you wish to deploy, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
Service #1 - rackula
docker run -d --name rackula \
-p 8383:8080 \
-e 'API_HOST=rackula-api' \
-e 'API_PORT=3001' \
-e 'RACKULA_LISTEN_PORT=8080' \
-e 'API_WRITE_TOKEN=${RACKULA_API_WRITE_TOKEN:-}' \
-e 'RACKULA_AUTH_MODE=${RACKULA_AUTH_MODE:-none}' \
-e 'RACKULA_ENABLE_IPV6=${RACKULA_ENABLE_IPV6:-auto}' \
-e 'NGINX_RESOLVER=127.0.0.11' \
--restart=always \
ghcr.io/rackulalives/rackula:latestService #2 - rackula-api
docker run -d --name rackula-api \
-e 'DATA_DIR=/data' \
-e 'RACKULA_API_PORT=3001' \
-e 'CORS_ORIGIN=${CORS_ORIGIN:-http://localhost:8383}' \
-e 'RACKULA_API_WRITE_TOKEN=${RACKULA_API_WRITE_TOKEN:-}' \
-e 'RACKULA_AUTH_MODE=${RACKULA_AUTH_MODE:-none}' \
-e 'RACKULA_AUTH_SESSION_SECRET=${RACKULA_AUTH_SESSION_SECRET:-}' \
-e 'RACKULA_AUTH_SESSION_MAX_AGE_SECONDS=${RACKULA_AUTH_SESSION_MAX_AGE_SECONDS:-43200}' \
-e 'RACKULA_AUTH_SESSION_IDLE_TIMEOUT_SECONDS=${RACKULA_AUTH_SESSION_IDLE_TIMEOUT_SECONDS:-1800}' \
-e 'RACKULA_AUTH_SESSION_GENERATION=${RACKULA_AUTH_SESSION_GENERATION:-0}' \
-e 'RACKULA_AUTH_SESSION_COOKIE_SAMESITE=${RACKULA_AUTH_SESSION_COOKIE_SAMESITE:-Lax}' \
-e 'RACKULA_AUTH_SESSION_COOKIE_SECURE=${RACKULA_AUTH_SESSION_COOKIE_SECURE:-true}' \
-e 'RACKULA_AUTH_CSRF_PROTECTION=${RACKULA_AUTH_CSRF_PROTECTION:-true}' \
-e 'ALLOW_INSECURE_CORS=${ALLOW_INSECURE_CORS:-false}' \
-v /portainer/Files/AppData/Config/rackula/data:/data \
--restart=always \
ghcr.io/rackulalives/rackula-api:latestIf the stack expects env vars, set them or add them to a .env file first.
services:
rackula:
image: ghcr.io/rackulalives/rackula:latest
container_name: rackula
restart: always
ports:
- "8383:8080"
environment:
- API_HOST=rackula-api
- API_PORT=3001
- RACKULA_LISTEN_PORT=8080
- API_WRITE_TOKEN=${RACKULA_API_WRITE_TOKEN:-}
- RACKULA_AUTH_MODE=${RACKULA_AUTH_MODE:-none}
- RACKULA_ENABLE_IPV6=${RACKULA_ENABLE_IPV6:-auto}
- NGINX_RESOLVER=127.0.0.11
stop_grace_period: 10s
deploy:
resources:
limits:
cpus: "0.50"
memory: 128M
reservations:
cpus: "0.10"
memory: 16M
#security_opt:
# - no-new-privileges:true
#cap_drop:
# - ALL
#read_only: true
tmpfs:
- /var/cache/nginx:size=10M
- /var/run:size=1M
- /tmp:size=5M
- /etc/nginx/conf.d:size=1M,uid=101,gid=101
logging:
driver: json-file
options:
max-size: "10m"
max-file: "3"
depends_on:
- rackula-api
rackula-api:
image: ghcr.io/rackulalives/rackula-api:latest
container_name: rackula-api
restart: always
stop_grace_period: 10s
volumes:
# Host directory must be writable by container user (uid 1001)
# Run: mkdir -p /portainer/Files/AppData/Config/rackula/data && chown 1001:1001 /portainer/Files/AppData/Config/rackula/data
- /portainer/Files/AppData/Config/rackula/data:/data
environment:
- DATA_DIR=/data
- RACKULA_API_PORT=3001
- CORS_ORIGIN=${CORS_ORIGIN:-http://localhost:8383}
- RACKULA_API_WRITE_TOKEN=${RACKULA_API_WRITE_TOKEN:-}
- RACKULA_AUTH_MODE=${RACKULA_AUTH_MODE:-none}
- RACKULA_AUTH_SESSION_SECRET=${RACKULA_AUTH_SESSION_SECRET:-}
- RACKULA_AUTH_SESSION_MAX_AGE_SECONDS=${RACKULA_AUTH_SESSION_MAX_AGE_SECONDS:-43200}
- RACKULA_AUTH_SESSION_IDLE_TIMEOUT_SECONDS=${RACKULA_AUTH_SESSION_IDLE_TIMEOUT_SECONDS:-1800}
- RACKULA_AUTH_SESSION_GENERATION=${RACKULA_AUTH_SESSION_GENERATION:-0}
- RACKULA_AUTH_SESSION_COOKIE_SAMESITE=${RACKULA_AUTH_SESSION_COOKIE_SAMESITE:-Lax}
- RACKULA_AUTH_SESSION_COOKIE_SECURE=${RACKULA_AUTH_SESSION_COOKIE_SECURE:-true}
- RACKULA_AUTH_CSRF_PROTECTION=${RACKULA_AUTH_CSRF_PROTECTION:-true}
- ALLOW_INSECURE_CORS=${ALLOW_INSECURE_CORS:-false}
deploy:
resources:
limits:
cpus: "0.25"
memory: 64M
reservations:
cpus: "0.05"
memory: 16M
security_opt:
- no-new-privileges:true
cap_drop:
- ALL
read_only: true
tmpfs:
- /tmp:size=5M
healthcheck:
test: ["CMD", "wget", "-qO-", "http://127.0.0.1:3001/health"]
interval: 30s
timeout: 10s
start_period: 5s
retries: 3
logging:
driver: json-file
options:
max-size: "5m"
max-file: "2"
expose:
- "3001"
Or, use the original compose file, straight from the template repo. Deploy with:
git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/rackula.yml up -dFor more installation options, see the Documentation in our GitHub repo
Serve Rackula 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 rackula.example.com to http://rackula:8080
Add this to your Caddyfile
rackula.example.com {
reverse_proxy http://rackula:8080
}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.
Port already in use
If deployment fails with "Bind for 0.0.0.0:8383 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :8383 - Stop the other service, or pick a different host port. In
8383:8080only 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:8383. The 0.0.0.0 link Portainer shows isn't a real address. - Give it a minute after first deploy, rackula can take a while to initialise.
- Make sure your firewall allows the port, e.g.
sudo ufw allow 8383
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/rackula/data
Image won't pull
Test the pull directly on the host: docker pull ghcr.io/rackulalives/rackula: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 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
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 within rackula's repo
- Template not working: Open an issue on xneo1/portainer_templates
- This website not working: Open an issue on lissy93/portainer-templates