Portainer Templates logo

Portainer Templates

Organizr (container) Organizr (container)

OtherTools

Organizr allows you to setup Tabs that will be loaded all in one webpage. You can then work on your server with ease.

Image details

Pulls: 76.3M
Architecture: amd64, arm64, arm/v7, arm
Image size: 25 MB
User: organizr
Created: Apr 10, 2020
Updated: 2 years ago
Status: active

Configuration

Type
Container
Platform
linux
Image
organizr/organizr:latest
Ports
80/tcp
Volumes
/config : /portainer/Files/AppData/Config/Organizr
Env vars
PUID=1000PGID=100
Restart
unless-stopped

Template by mikestraney

Standalone Install

Select an install method, to see config/commands for deploying Organizr (container)

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 Organizr (container), fill in any config options, and hit Deploy

Template Import URL

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

More install options in our documentation.

organizr/organizr

Size Docker Pulls Discord Chat License
An HTPC/Homelab services organizer that is written in PHP.

Usage

docker create \
  --name=organizr \
  -v /path/to/data:/config \
  -e PGID=1000 -e PUID=1000  \
  -p 80:80 \
  -e branch="v2-master" `#optional` \
  ghcr.io/organizr/organizr

Entries marked with optional is showing the default value
Note: Organizr is not contained inside the image, this means that using the built-in updater does not break your install. However the prefered way to update organizr is to restart the container, as we grab the latest commit on startup.

Parameters

The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 and http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.
  • -p 80 - The port(s)
  • -v /config - Mapping the config files for Organizr
  • -e PGID Used for GroupID - see below for explanation
  • -e PUID Used for UserID - see below for explanation
  • -e branch Used to switch between branches of organizr. Valid values are(comma separated) v2-master, master, v2-develop, develop, dev. v2-master and master will yield the v2-master branch. v2-develop, develop and dev will yield the v2-develop branch

It is based on Alpine Linux with an s6 overlay.

User / Group Identifiers

Sometimes when using data volumes (-v flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user PUID and group PGID. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
In this instance PUID=1001 and PGID=1001. To find yours use id user as below:
$ id <dockeruser>
  uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)

.original and .rework files

Sometimes we change files that is used by the container, in this case we backup your old files, and replace them with the new ones.

Multi-arch

Manifested docker images built with buildkit.
Supported architetures:
ArchitectureTag
x86-64linux-amd64
arm64linux-arm64
armhflinux-arm-v7

Migration

This is a drop-in replacement coming from organizrtools/organizr-v2.
Key-changes:
  • The nginx config file for the healthcheck is moved to it's own file, under /config/nginx/site-confs/healthcheck.

  • Moving the install directory from /config/www/Dashboard to /config/www/organizr, Nginx should also be updated with this change.

  • One tag. While we could have set PHP to use the unix socket as default, we opted to using a environment varible We have now set up to use the unix socket exclusively. We also moved the branch selector to be a environment variable.

OldNew
organizrtools/organizr-v2ghcr.io/organizr/organizr
organizrtools/organizr-v2:dev-e branch=dev ghcr.io/organizr/organizr
organizrtools/organizr-v2:php-fpmghcr.io/organizr/organizr
organizrtools/organizr-v2:dev-php-fpm-e branch=dev ghcr.io/organizr/organizr

  • organizrtools/organizr-v2:plex and organizrtools/organizr-v2:dev-plex does not have a migration path.

Setting up the application

Setup accounts, service tabs, etc. via the webUI. More info can be found on the official Organizr GitHub repository.

Info

  • Shell access whilst the container is running: docker exec -it organizr /bin/bash
  • To monitor the logs of the container in realtime: docker logs -f organizr

Credits

  • causefx - The man behind Organizr
  • Chris Yocum - For creating, and maintaining the original container
  • Roxedus - For updating and redoing the CI pipeline and container

Serve Organizr (container) 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 organizr-container.example.com to http://organizr-v2:80

Add this to your Caddyfile

organizr-container.example.com {
	reverse_proxy http://organizr-v2: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 organizr-v2
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Published on a random port

This template exposes 80/tcp without setting a host port, so Docker picks a random free one on every deploy.

  • Find it in the Ports column of Portainer's container list, or with docker port organizr-v2

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:100 /portainer/Files/AppData/Config/Organizr
  • Or set the PUID and PGID variables (defaults 1000:100) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull organizr/organizr: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.

  • This image supports: amd64, arm64, arm/v7, arm
  • 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 organizr-v2 --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Organizr (container) runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Organizr (container) needs bundled into one download. This template pulls organizr/organizr:latest, which Docker fetches once (about 25 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Organizr (container)'s comes from Docker Hub, published by organizr.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, arm, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. Here the app exposes a port but leaves the host side blank, so Docker picks a free one for you. It opens:

  • 80, published on a random host port

Volumes

A volume is where Organizr (container) 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:

  • /config from /portainer/Files/AppData/Config/Organizr on the host

Environment variables

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

  • PUID, defaults to 1000
  • PGID, defaults to 100

Restart policy

The restart policy here is unless-stopped, so Docker restarts Organizr (container) 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

Nothing custom is set, so Organizr (container) sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container organizr-v2. That's what you'll spot in the containers list and use in commands like docker logs organizr-v2.

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 Organizr (container) up. Add the template list to Portainer once, then deploying Organizr (container) is a click rather than a wall of config.