organizr/organizr

An HTPC/Homelab services organizer that is written in PHP.

Usage

docker create \
  --name=organizr \
  -v <path to data>:/config \
  -e PGID=<gid> -e PUID=<uid>  \
  -p 80:80 \
  -e fpm="false" \ # optional
  -e branch="v2-master" \ # optional
  organizr/organizr

Entries marked with optional is showing the default value

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 fpm Used to enable php to use the socket rather than TCP, often increases performance. Valid values are(comma separated) true, false
-e branch Used to switched between branches of organizr. Valid values are(comma separated) v2-master, master, v2-develop, develop, dev

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:

Architecture	Tag
x86-64	amd64
arm64	arm64
armhf	arm

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 maintainig the original container
Roxedus - For updating and redoing the CI pipeline and container

jonathanfinley / docker-organizr