Home

Awesome

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.

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:

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

Setting up the application

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

Info

Credits