2019-10-01 02:59:02 +00:00
# [linuxserver/organizr](https://github.com/linuxserver/docker-organizr)
2019-02-11 19:01:55 +00:00
2019-11-05 03:59:05 +00:00
[](https://github.com/linuxserver/docker-organizr)
[](https://github.com/linuxserver/docker-organizr/releases)
[](https://github.com/linuxserver/docker-organizr/packages)
[](https://gitlab.com/Linuxserver.io/docker-organizr/container_registry)
[](https://quay.io/repository/linuxserver.io/organizr)
2019-10-01 02:59:02 +00:00
[](https://microbadger.com/images/linuxserver/organizr "Get your own version badge on microbadger.com")
2019-11-05 03:59:05 +00:00
[](https://hub.docker.com/r/linuxserver/organizr)
[](https://hub.docker.com/r/linuxserver/organizr)
2019-10-01 02:59:02 +00:00
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-organizr/job/master/)
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/organizr/latest/index.html)
2019-02-11 19:01:55 +00:00
[Organizr ](https://github.com/causefx/Organizr ) is a HTPC/Homelab Services Organizer - Written in PHP
2019-10-01 02:59:02 +00:00
Do you have quite a bit of services running on your computer or server?
Do you have a lot of bookmarks or have to memorize a bunch of ip's and ports?
Well, Organizr is here to help with that. Organizr allows you to setup "Tabs" that will be loaded all in one webpage.
You can then work on your server with ease. You can even open up two tabs side by side.
Want to give users access to some Tabs? No problem, just enable user support and have them make an account.
Want guests to be able to visit too? Enable Guest support for those tabs.
For more information on Organizr and information on how to use it visit their site at https://github.com/causefx/Organizr
2019-02-11 19:01:55 +00:00
## Supported Architectures
2019-09-03 02:59:06 +00:00
Our images support multiple architectures such as `x86-64` , `arm64` and `armhf` . We utilise the docker manifest for multi-platform awareness. More information is available from docker [here ](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list ) and our announcement [here ](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/ ).
2019-02-11 19:01:55 +00:00
Simply pulling `linuxserver/organizr` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
| Architecture | Tag |
2019-10-01 02:59:02 +00:00
| :----: | --- |
2019-02-11 19:01:55 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 22:14:54 +00:00
| armhf | arm32v7-latest |
2019-02-11 19:01:55 +00:00
2019-10-01 02:59:02 +00:00
2019-02-11 19:01:55 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-10-01 02:59:02 +00:00
```
2019-02-11 19:01:55 +00:00
docker create \
--name=organizr \
2019-03-01 22:17:37 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-11 19:01:55 +00:00
-e TZ=< your timezone , eg Europe / London > \
-p 9983:80 \
-v < path to data > :/config \
--restart unless-stopped \
linuxserver/organizr
```
2019-10-01 02:59:02 +00:00
2019-02-11 19:01:55 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
organizr:
image: linuxserver/organizr
container_name: organizr
environment:
2019-03-01 22:17:37 +00:00
- PUID=1000
- PGID=1000
2019-02-11 19:01:55 +00:00
- TZ=< your timezone , eg Europe / London >
volumes:
- < path to data > :/config
ports:
- 9983:80
restart: unless-stopped
```
## Parameters
2019-10-01 02:59:02 +00:00
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
2019-02-11 19:01:55 +00:00
2019-10-01 02:59:02 +00:00
### Ports (`-p`)
2019-02-11 19:01:55 +00:00
| Parameter | Function |
2019-10-01 02:59:02 +00:00
| :----: | --- |
2019-02-11 19:01:55 +00:00
| `80` | will map the container's port 80 to port 9983 on the host |
2019-10-01 02:59:02 +00:00
### Environment Variables (`-e`)
2019-02-11 19:01:55 +00:00
| Env | Function |
2019-10-01 02:59:02 +00:00
| :----: | --- |
2019-03-01 22:17:37 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-11 19:01:55 +00:00
| `TZ=<your timezone, eg Europe/London>` | for specifying your timezone |
2019-10-01 02:59:02 +00:00
### Volume Mappings (`-v`)
2019-02-11 19:01:55 +00:00
| Volume | Function |
2019-10-01 02:59:02 +00:00
| :----: | --- |
2019-02-11 19:01:55 +00:00
| `/config` | this is where your user data and logs will live |
2019-10-01 02:59:02 +00:00
2019-02-11 19:01:55 +00:00
## User / Group Identifiers
2019-10-01 02:59:02 +00:00
When using 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` .
2019-02-11 19:01:55 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-01 22:17:37 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-11 19:01:55 +00:00
2019-10-01 02:59:02 +00:00
```
2019-02-11 19:01:55 +00:00
$ id username
2019-03-01 22:17:37 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-11 19:01:55 +00:00
```
## Application Setup
Dead simple to get running, create the container as instructed and start it. When up and running, load the site.
2019-10-01 02:59:02 +00:00
2019-02-11 19:01:55 +00:00
## Support Info
2019-09-03 02:59:06 +00:00
* Shell access whilst the container is running:
2019-02-11 19:01:55 +00:00
* `docker exec -it organizr /bin/bash`
2019-09-03 02:59:06 +00:00
* To monitor the logs of the container in realtime:
2019-02-11 19:01:55 +00:00
* `docker logs -f organizr`
2019-09-03 02:59:06 +00:00
* Container version number
2019-02-11 19:01:55 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' organizr`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/organizr`
## Versions
2019-04-17 22:36:10 +00:00
* **18.04.19:** - Fix new install not working.
2019-03-24 22:14:54 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-27 00:09:36 +00:00
* **26.02.19:** - Upgrade packages during install to prevent mismatch with baseimage.
2019-02-25 01:57:30 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-11 19:01:55 +00:00
* **11.02.19:** - Fix permissions on new app location
* **31.12.18:** - Moved to pipeline building from v1-master branch
* **05.09.18:** - Rebase to Alpine 3.8
* **10.01.18:** - Rebase to Alpine 3.7
* **25.05.17:** - Rebase to Alpine 3.6
* **02.05.17:** - Added php7-curl package
* **12.04.17:** - Added php7-ldap package
* **10.03.18:** - Initial Release.
