2c75cfe0ea
* dhcp uses on, not true (because iocage syntax) * Documentation updates * Add gh-pages wiki generator using mkdocs * Update shellcheck.yml * Update wiki.yml * Add filecheck * readme case correction1 * readme case correction2 * Update filecheck.yml
101 lines
6.2 KiB
Markdown
Executable File
101 lines
6.2 KiB
Markdown
Executable File
# Organizr
|
|
|
|
## Original README from the Organizr github repo:
|
|
|
|
https://github.com/causefx/Organizr
|
|
|
|
|
|
<p align="center"><img src="https://github.com/causefx/Organizr/raw/v2-develop/plugins/images/organizr/logo-wide.png"></p>
|
|
|
|
[](http://isitmaintained.com/project/causefx/Organizr "Percentage of issues still open")
|
|
[](http://isitmaintained.com/project/causefx/Organizr "Average time to resolve an issue")
|
|
[](https://github.com/causefx/Organizr/stargazers)
|
|
[](https://github.com/causefx/Organizr/network)
|
|
[](https://hub.docker.com/r/organizrtools/organizr-v2)
|
|
[](https://paypal.me/causefx)
|
|
[](https://beerpay.io/causefx/Organizr) [](https://beerpay.io/causefx/Organizr?focus=wish)
|
|
|
|
<img src="https://user-images.githubusercontent.com/16184466/53614282-a91e9e00-3b96-11e9-9b3e-d249775ecaa1.png">
|
|
|
|
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. 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.
|
|
|
|
<img src="https://user-images.githubusercontent.com/16184466/53614285-a9b73480-3b96-11e9-835e-9fadd045582b.png">
|
|
|
|
- PHP 7.1.3+
|
|
- [Official Site](https://organizr.app) - Will be refreshed soon!
|
|
- [Official Discord](https://organizr.app/discord)
|
|
- [See Wiki](https://github.com/causefx/Organizr/wiki) - Will be updated soon!
|
|
- [Docker](https://hub.docker.com/r/organizrtools/organizr-v2/)
|
|
|
|
<img src="https://user-images.githubusercontent.com/16184466/53614284-a9b73480-3b96-11e9-9bea-d7a30b294267.png">
|
|
|
|
<img src="https://user-images.githubusercontent.com/16184466/53615855-35cc5a80-3b9d-11e9-882b-f09f3eb18173.png" width="23%"></img> <img src="https://user-images.githubusercontent.com/16184466/53615856-35cc5a80-3b9d-11e9-8428-1f2ae05da2c9.png" width="23%"></img> <img src="https://user-images.githubusercontent.com/16184466/53615857-35cc5a80-3b9d-11e9-82bf-91987c529e72.png" width="23%"></img> <img src="https://user-images.githubusercontent.com/16184466/53615858-35cc5a80-3b9d-11e9-8149-01a7fcd9160a.png" width="23%"></img>
|
|
|
|
[](https://www.youtube.com/watch?v=LZL4smFB6wU)
|
|
|
|
<img src="https://user-images.githubusercontent.com/16184466/53614283-a9b73480-3b96-11e9-90ef-6e752e067884.png">
|
|
|
|
- Login with Plex/Emby/LDAP or sFTP credentials
|
|
- Custom tabs for your services
|
|
- Fullscreen Support
|
|
- Pin/Unpin sidebar
|
|
- Mobile support
|
|
- Set default page on launch
|
|
- Upload new icons with ease
|
|
- Enable or disable iFrame for your tabs
|
|
- User management support: Create, delete and promote users from the user management console
|
|
- Unlimited User Groups
|
|
- Theme-able
|
|
- Personalise any theme: Customise the look and feel of Organizr with access to the colour palette
|
|
- Organizr login log viewer
|
|
- Fail2ban support (see wiki)
|
|
- Nginx Auth_Request support
|
|
- Protect new user account creation with registration password
|
|
- 'Forgot Password' support [receive an email with your new password, prerequisites: mail server setup]
|
|
- Multiple login support
|
|
- Keyboard shortcut support (Check help tab in settings)
|
|
- Gravatar Support
|
|
- Customise the top bar by adding your own site logo or site name
|
|
- Additional language support
|
|
- Quick access tabs [access your tabs quickly e.g. www.example.com/#Sonarr]
|
|
- Many more...
|
|
|
|
<img src="https://user-images.githubusercontent.com/16184466/53614286-a9b73480-3b96-11e9-8495-4944b85b1313.png">
|
|
|
|
[](http://feathub.com/causefx/Organizr)
|
|
|
|
<img src="https://user-images.githubusercontent.com/16184466/53667702-fcdcc600-3c2e-11e9-8828-860e531e8096.png">
|
|
|
|
##### Usage
|
|
```
|
|
docker create \
|
|
--name=organizr \
|
|
-v <path to data>:/config \
|
|
-e PGID=<gid> -e PUID=<uid> \
|
|
-p 80:80 \
|
|
organizrtools/organizr-v2
|
|
```
|
|
##### 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
|
|
|
|
##### 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`
|
|
* Container version number: `docker inspect -f '{{ index .Config.Labels "build_version" }}' organizr`
|
|
* Image version number: `docker inspect -f '{{ index .Config.Labels "build_version" }}' organizrtools/docker-organizr-v2`
|
|
|
|
<img src="https://user-images.githubusercontent.com/16184466/53614287-a9b73480-3b96-11e9-9c8e-e32b4ae20c0d.png">
|
|
|
|
<p align="center"><a href="https://www.browserstack.com"><img src="https://avatars2.githubusercontent.com/u/1119453?s=200&v=4g"></a></p>
|
|
<p align="center"><a href="https://www.browserstack.com">BrowserStack</a> for allowing us to use their platform for testing</p>
|
|
<p>This project is supported by:</p>
|
|
<p>
|
|
<a href="https://www.digitalocean.com/">
|
|
<img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="201px">
|
|
</a>
|
|
</p> |