Portainer Templates logo

Portainer Templates

Nginx Proxy Manager v2 with Sqlite and Goaccess Charts Nginx Proxy Manager v2 with Sqlite and Goaccess Charts

Stack

ProxyTools

Nginx Proxy Manager v2 with sqlite and Goaccess Charts enables you to easily forward to your websites running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt. Please see the install document at https://github.com/pi-hosted/pi-hosted/tree/master/docs installing the template

Configuration

Type
Compose
Platform
linux
Ports
80:80/tcp81:81/tcp443:443/tcp7880:7880/tcp
Env vars
PUID=1000PGID=1000TZ=America/New_YorkSKIP_ARCHIVED_LOGS=falseBASIC_AUTH=falseBASIC_AUTH_USERNAME=userBASIC_AUTH_PASSWORD=Password
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://nginxproxymanager.com/
Official Docker Documentation: https://nginxproxymanager.com/setup/#running-the-app

Pi-Hosted dedicated documentation: nginx_proxy_manager.md




Youtube Video: Novaspirit Tech - Installing Nginx Proxy Manager on Docker

Services

app

Configuration

Image
jc21/nginx-proxy-manager:latest
Ports
80:80443:44381:81
Volumes
/data : /portainer/Files/AppData/Config/nginx-proxy-manager/data/etc/letsencrypt : /portainer/Files/AppData/Config/nginx-proxy-manager/letsencrypt
Restart
unless-stopped

Image details

Pulls: 267.3M
User: jc21
Created: Dec 11, 2017
Updated: 2 months ago
Status: active

stats

Configuration

Image
justsky/goaccess-for-nginxproxymanager:latest
Ports
7880:7880
Volumes
/opt/log : /portainer/Files/AppData/Config/nginx-proxy-manager/data/logs
Env vars
PUID=${PUID}PGID=${PGID}TZ=${TZ}SKIP_ARCHIVED_LOGS=${SKIP_ARCHIVED_LOGS}BASIC_AUTH=${BASIC_AUTH}BASIC_AUTH_USERNAME=${BASIC_AUTH_USERNAME}BASIC_AUTH_PASSWORD=${BASIC_AUTH_PASSWORD}
Restart
unless-stopped

Image details

Pulls: 525k
User: justsky
Created: Mar 02, 2022
Updated: 1 years ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Nginx Proxy Manager v2 with Sqlite and Goaccess Charts

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 Nginx Proxy Manager v2 with Sqlite and Goaccess Charts, 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"
services:
  app:
    image: jc21/nginx-proxy-manager:latest
    container_name: nginx-proxy-manager
    volumes:
      - /portainer/Files/AppData/Config/nginx-proxy-manager/data:/data
      - /portainer/Files/AppData/Config/nginx-proxy-manager/letsencrypt:/etc/letsencrypt
    depends_on:
      - stats
    ports:
      - 80:80
      - 443:443
      - 81:81
    restart: unless-stopped

  stats:
    image: justsky/goaccess-for-nginxproxymanager:latest
    restart: unless-stopped
    environment:
      PUID: ${PUID}
      PGID: ${PGID}
      TZ: ${TZ}
      SKIP_ARCHIVED_LOGS: "${SKIP_ARCHIVED_LOGS}"
      BASIC_AUTH: "${BASIC_AUTH}"
      BASIC_AUTH_USERNAME: ${BASIC_AUTH_USERNAME}
      BASIC_AUTH_PASSWORD: ${BASIC_AUTH_PASSWORD}
    ports:
      - 7880:7880
 
    volumes:
      - /portainer/Files/AppData/Config/nginx-proxy-manager/data/logs:/opt/log:ro

Or deploy it directly from the source:

git clone https://github.com/pi-hosted/pi-hosted
cd pi-hosted
docker compose -f stack/nginx-proxy-manager-sqlite-goaccess.yml up -d

More install options in our documentation.

Container Documentation

app Documentation

Docker container for managing Nginx proxy hosts with a simple, powerful interface

stats Documentation

Multi-arch image

Serve Nginx Proxy Manager v2 with Sqlite and Goaccess Charts 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 nginx-proxy-manager-v2-with-sqlite-and-goaccess-charts.example.com to http://app:80

Add this to your Caddyfile

nginx-proxy-manager-v2-with-sqlite-and-goaccess-charts.example.com {
	reverse_proxy http://app:80
}

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

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

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 ${PUID}:${PGID} /portainer/Files/AppData/Config/nginx-proxy-manager/data (and the same for the other mapped folders)
  • Or set the PUID and PGID variables (defaults ${PUID}:${PGID}) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull jc21/nginx-proxy-manager: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

Nginx Proxy Manager v2 with Sqlite and Goaccess Charts 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:

  • app runs jc21/nginx-proxy-manager:latest, starts after stats
  • stats runs justsky/goaccess-for-nginxproxymanager:latest

Ports

A port is the door the app answers on. A mapping like 80:80 means it's reachable on port 80 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:80 in a browser. It opens:

  • 80:80, likely the web interface
  • 443:443, likely the web interface
  • 81:81
  • 7880:7880

Volumes

A volume is where Nginx Proxy Manager v2 with Sqlite and Goaccess Charts 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:

  • /data from /portainer/Files/AppData/Config/nginx-proxy-manager/data on the host
  • /etc/letsencrypt from /portainer/Files/AppData/Config/nginx-proxy-manager/letsencrypt on the host
  • /opt/log from /portainer/Files/AppData/Config/nginx-proxy-manager/data/logs on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Nginx Proxy Manager v2 with Sqlite and Goaccess Charts takes 7 of them, all with defaults you can leave alone or tweak:

  • PUID, pulled from your own environment
  • PGID, pulled from your own environment
  • TZ, pulled from your own environment
  • SKIP_ARCHIVED_LOGS, pulled from your own environment
  • BASIC_AUTH, pulled from your own environment
  • BASIC_AUTH_USERNAME, pulled from your own environment
  • BASIC_AUTH_PASSWORD, pulled from your own environment

Restart policy

The restart policy here is unless-stopped, so Docker restarts Nginx Proxy Manager v2 with Sqlite and Goaccess Charts 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).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like app) 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 Nginx Proxy Manager v2 with Sqlite and Goaccess Charts up. Add the template list to Portainer once, then deploying Nginx Proxy Manager v2 with Sqlite and Goaccess Charts is a click rather than a wall of config.