Summary

Are you getting stuck in a redirect loop? Are you seeing some console errors in your browser about SameSite Cookies?

Browsers are starting to enforce strict rules on Cookies set by web apps. The issue here is when an application is not hosted on the same host as Organizr. You have three options...

Options

C:\Windows\System32\drivers\etc

NZBHydra has as of version 2.13.13 the ability to authorize using a similar method as Grafana.

In NZBHydra's settings we need to set a few values. The Auth header has to have the same as the one in the NGINX reverse proxy (example to follow), while the Secure ip ranges should be set to the nginx ip.

Summary

Organizr ships with a few options to use as the user management backend. Backends allow Organizr to authenticate user logins to gain access to Organizr.

Default Backend

The default backend is Organizr's built in user management. It allows all user functions such as:

• Add Users

• Delete Users

• Edit Users

While using the default backend from Organizr, you may also add a secondary backend server to utilize as another option to authenticate. Using this option still allows you the same user functions from Organizr's backend listed above.

To get to the other backends head to the above path and change the Authentication Type option to Organizr DB + Backend and change the Authentication Backendoption.

Summary

The Plex homepage item allows you to have the following Plex items displayed on the homepage:

• Current playing streams (Active Streams)

• Recently Added items

• Media search functionality

• Playlists

When setting up the Plex homepage item, the first option is to enable it, do that by toggling the Enable Switch. After that you need to set the Minimum Authentication group that will be able to use this item.

If you already went through the or setup you will have these next fields already saved, if not, you can hit set those values using the provided buttons.

With this module, you will be able to show the current streams that are active on your Plex server live.

With this module, you will be able to display all recent items that were added to your Plex server.

With this module, you will be able to show a search button on your Organizr so users may search your library.

With this module, you will be able to show your curated playlists from your Plex server.

Folder Structure

Each plugin consists of the following files:

The first thing you will notice is that there is a Global variable set with a plugins array. For this example, our Plugin name is Test.

Also notice on the array we again specify the name of the plugin. Here is a breakdown of the rest of the array keys:

Now that we have finished setting up your Plugin's Global variable array, we can now continue to creating your Plugin's PHP Class.

If you plan on using some of Organizr built in functions and User information, you will need to extend the Organizr Class. Otherwise, you can just create a new class and that is it.

If you want a settings modal, you will need to create a function to supply which config items you will want to set up for your settings modal. Let's start with creating a function to pass an array with our config items.

First, you need to name your function something, let's call this one _pluginGetSettings, we can also set this function as public if you choose to share those variables with other classes etc...

Next, we will return an array with our Setting's groups. In this example our first Group is called Sample Settings. Inside this Settings group, we will have 3 config items that we want to setup. Each item is setup via the settingsOption function. This function takes 3 parameters.

The first option is the type of config item that we are setting up. The second, is the name of the config item. Lastly, we can provide the sometimes-optional extra options needed to set the item up.

Let's take a look at each one.

You can find out all the type of config item options under the options-functions.php file located under Organizr Location/api/functions/ folder.

Summary

This homepage item allows you to have the following items displayed on the homepage:

• Calendar (Upcoming and Past TV Shows)

• Queue (Current Downloading Items)

• API Socks (Access to API without needing to Reverse Proxy Sonarr)

When setting up the homepage item, the first option is to enable it, do that by toggling the Enable Switch. After that you need to set the Minimum Authentication group that will be able to use this item.

Enter the connection details of your Sonarr server. This homepage item allows multiple Sonarr server connections.

Organizr's API Socks allows you to access Sonarr's API without needing to Reverse Proxy it.

Depending on if you entered either one Sonarr Connection or multiple will determine which URL you will use.

Enabling this module will output Sonarr's Download Queue on the homepage.

This module adds past and future TV Shows on the homepage Calendar

Summary

Using SSO with Overseerr allows you to access the Overseerr UI using only one sign in.

An example Caddy V2 Caddyfile with reverse proxy

Calibre added support to Auth via header in v0.6.5. You need to set the Calibre settings in the Admin Configuration.

The Reverse Proxy Header Name should be the header you set in your reverse proxy config.

Here is an example calibre.conf file for a subdomain of https://domain.com/calibre

Docker

Steps

• Remove index.lockif it tells you to

• Restart container

• Profit

Summary

SSO with Grafana is a combination of reverse proxy configuration and some settings in grafana.ini or with environment variables.

Grafana.ini

Environment variables

Notes

You need to flip the enabled to true (it's disabled by default) and you should set the whitelist to the IP of your Organizr install so the header can only come from it. To read more about this, see Grafana's docs.

Summary

Get faster load times of tabs in Organizr.

Windows

1. Open Command Prompt as an Administrator

2. Type the following command set php and you should see 2 variables

   1. PHP_FCGI_CHILDREN=3

   2. PHP_FCGI_MAX_REQUESTS=128

3. Run the following command to increase the value of PHP_FCGI_CHILDREN

   1. SETX /m PHP_FCGI_CHILDREN 1000

4. Close Command Prompt.

5. Open Command Prompt as Administrator and run set php and check that PHP_FCGI_CHILDREN value changed from 3 to 1000.

Adapted from:

Summary

Using Plex as your Organizr backend allows you to authenticate using both your Local Plex Server as well as the servers at Plex.tv

Change the Authentication type to Organizr DB + Backend. Choose Plex as the Authentication Backend. Use the Retrieve button to fill in the Plex Token and Plex Machine.‌

You can use Traefik's auth-forward feature to do the same.

Example docker-compose.yml block for Organizr:

Example service that depends on user being authenticated to Organizr:

Træfik changed how the tags work in v2.

Example docker-compose.yml block for Organizr:

Example service that depends on user being authenticated to Organizr:

Using SSO with Petio allows you to access the Petio UI using only one sign in.

1. Webserver - Nginx (or any other webserver that works with php)

2. PHP 7.1.3 or later

   1. PDO

Summary

Before installing Organizr you need to have a couple of pieces of software installed.

If you are running Docker Containers, you can skip to Installing Organizr via Docker.

Webserver

Do you have a Web Server installed?

If you do not please proceed to the following page:

PHP

Do you have PHP installed?

If you do not please proceed to the following page:

Prerequisites Completed

If you have both a Web Server and PHP installed, head over to this page:

Summary

Using LDAP as your backend allows you to authenticate using your own LDAP server. With that being said there are currently some limitation in Organizr. These will be covered at the bottom of this page.

Coming soon...

In the event that something isn't working as expected, here we will short where to start looking to troubleshoot.

In the drop down under your username in the top right there is an option for the Debug Area. From here use the drop down at the top and choose the SSO option you are trying to troubleshoot.

Sometime you need to backup and/or restore your instance of Organizr.

Head on over to the Backup module of Organizr

All that you need to do is click the Create Backup Button

Once the backup process completes, the new back up will be listed at the bottom of the back up listing. There are 2 buttons that are accessible for each backup.

The left button is the download button which will download the zip file that includes all the backed up files. The right button will delete that specific backup zip file.

Using SSO with Komga allows you to access the Komga UI using only one sign in.

Single Sign on is used to log into other services when you log into Organizr. You must be using the same username and password to log into Organizr as you would use to log into Plex, Ombi, Tautulli, etc...

Allow me to re-introduce myself My name is...

Summary

Using SSO with Jellyfin allows you to access the Jellyfin UI using only one sign in.

Summary

To display text only for specific user groups.

In this example, we are using groupID 999 which is the Guest Group.

<script>
    if(activeInfo.user.groupID !== 999){
        var cssSettings = `
            .hidden-for-non-guest {
                display: none;
            }
        `;
        $('#guest-css').html(cssSettings);
    }
</script>
<style id="guest-css"></style>
<div class="hidden-for-non-guest">
    <h1>You're a guest.  Please log in!</h1>
</div>
This is text everyone sees.

Steps

Open the Tab Editor and go to Homepage Items then finally select Custom HTML

Next you will Click which Custom HTML segment you want to use and Enableit then change the Minimum Authentication to the group you want to allow to see it. Next you will copy the code from above and paste it into the box at the bottom. Finally hit the 💾 button.

Outcome

A User who is logged in

Summary

The homepage houses all of your media items formatted in a very nice UI for you and your users.

Homepage Output

Setting up the Homepage Tab

By default, Organizr automatically sets up the Tab for the homepage but it will not be active. To activate it just toggle the Active switch. Once it is active, you can now configure Category and Group which you can get to by clicking the📝 button.

The URL will never change as that points to the Organizr API. You may change the Tab Name and Tab Image to anything you like. As for the other options, those are covered in Adding a New Tab

To setup a Homepage item, all you need to do is click on any of the homepage items to edit those settings. You may head to each Homepage item information page next.

If you are using Plex as the main driving factor for your Organizr instance, you will want to enable Plex as backend choice to login via Plex credentials.

Change the Authentication type to Organizr DB + Backend. Choose Plex as the Authentication Backend. Use the Retrieve button to fill in the Plex Token and Plex Machine.

The other two toggles are optional:

This is caused by Caddy not adding the necessary headers when forwarding the login request to Organizr.

Using the "transparent" preset or manually adding the necessary headers solves the issue.

For Example:

See more:

We are always looking for someone who would like to join us and help. No matter how small or big... We will take all the help we can get.

Join us and help contribute to Organizr's Documentation. The link to join is here:

Once you have joined, hop onto our Discord server and let us know which username you signed up with on Gitbook and we can apply the correct permissions for you or add your name to this list after you use the invite link:

Join us and help other members out that configuring and tinkering with Organizr over in our Discord server. Join the server here:

Coming soon...

Summary

Using SSO with Proxy Auth allows you to access an apps UI using only one sign in.

All of these type of apps work the same way. For the reverse proxy you need to add the following:

auth_request /organizr-auth/X; #Change the X to whatever group you want to allow access
auth_request_set $auth_user $upstream_http_x_organizr_user;
proxy_set_header X-WEBAUTH-USER $auth_user;

Summary

The second component needed for Organizr to run is PHP.

Windows

Download and Install

1. Download PHP for Windows from here: http://windows.php.net/download (Non Thread Safe version used in this guide)

2. Create a folder called PHP under your Nginx directory e.g. C:\nginx\php and copy the downloaded files to this folder

Running PHP as a service

1. Install NSSM - Skip to Step 2 if already installed

   1. Download NSSM from:

   2. Copy the nssm.exe from the win32 or win64 folder depending on your system to C:\Windows\System32

2. If you’ve got nssm already setup, open command prompt as admin.

3. Type in the following cmd nssm install php

   1. Path = C:\nginx\php\php-cgi.exe

   2. Startup directory = C:\nginx\php
4. Install Service

5. On the opened cmd prompt type in nssm start php to start the PHP service.

6. If the installed PHP service doesn’t start, then try manually running the php-cgi.exe file in C:\nginx\php\

   1. If you get a missing ‘VCRUNTIME’ related error then follow the solution on this link:

7. Make a copy of one of the php.ini-development or php.ini-production files and rename it to php.ini

8. Open the php.ini file and search for the following and uncomment each:

   1. extension_dir = "ext"

   2. extension=php_openssl.dll

   3. extension=php_pdo_sqlite.dll
9. Please note that if you are running PHP 7.2 or higher, look for the below lines and uncomment them instead:

   1. extension_dir = "ext"

   2. extension=openssl

   3. extension=pdo_sqlite
10. Also, uncomment the following line and add ext to the end of it:

    1. sqlite3.extension_dir =

       1. So that is becomes: sqlite3.extension_dir = ext

11. On the opened cmdprompt type in nssm restart php to restart the PHP service to apply the changes in php.ini.

Then, to be sure all of the PHP packages are installed, run the following command with your package manager. Some of these may also require other dependencies, so select "Yes" to install those as well.

Summary

Fail2ban scans log files (e.g. /var/log/nginx/error.log) and bans IPs that show malicious signs -- too many password failures, seeking for exploits, etc. Generally Fail2Ban is then used to update firewall rules to reject the IP addresses for a specified amount of time, although any arbitrary other action (e.g. sending an email/notification) could also be configured.

Prerequisites

• Fail2ban installed and configured

Fail2Ban filter

Go to your filter.d folder in your Fail2Ban install location /etc/fail2ban/filter.d and create a file called organizr-auth.conf and add the following:

[Definition]
failregex = {"log_level":"WARNING","message":"Wrong Password".*,"remote_ip_address":"<HOST>"
ignoreregex =

Organizr Jail

Edit the jail.local file in the Fail2Ban directory and add the following:

The ignore IP is so that fail2ban won’t ban your local IP. Check out if you are wondering what your is. Most often it will be /24 (netmask 255.255.255.0) To find your netmask run ipconfig /all on windows or ifconfig | grep netmask on linux.

Restart Fail2Ban with sudo service fail2ban restart

Normal Install

Docker Install

Because the Organizr container only logs the docker IP addresses e.g 172.17.0.2 you need to add this in the Organizr default nginx site file. Go to \organizr\nginx\site-confs\default and add the following inside the server block:

If you're using organizr/organizr it's already added and you only need to uncomment the set_real_ip_from line.

Then restart the container: docker restart organizr

For this to work you need the SWAG container to be able to read the organizr-<date>.log file in the Organizr container.

Mount the Organizr log like this:

And set the log path in the Fail2Ban jail.local file to /organizrlog/organizr*.log

The fail2ban.log file should output something like this:

If you managed to ban yourself or a friend banned themself you can run one of these commands:

Thanks to rix1337 for the fail2ban config:

Summary

The Tautulli SSO module works best if you are using Plex as your Organizr Backend.

You first need to make sure that Allow Plex Admin & Allow Guest Access to Tautulli are enabled in the Web Interface portion of the Settings page.

To enable Tautulli SSO for your users, head to Tautulli Users page and click Edit mode and click the Lock Icon for each user you want to enable SSO for.

A reverse proxy is a server that sits in front of web servers and forwards client (e.g. web browser) requests to those web servers. Reverse proxies are typically implemented to help increase security, performance, and reliability.

The NGINX configs that come with the automated Organizr installer for Windows are set up with a couple files to make settings up your reverse proxies easier. This guide assumes you used the default C:\nginx, If you are not using the default path, adjust what this says to the path you used. Inside that folder, in the conf folder, there are two files: rp-subfolder.conf and rp-subdomain.conf. These are the files we are going to be working with. We're also going to use the example configs that can be found (this link is also found in those files)

For configs that are just a location block, you are going to put them inside the rp-subfolder.conf file. We're going to use Sonarr as an example. Using these will create a reverse proxy that looks like

Organizr Tabs is the main focus of Organizr. You can have as many tabs as you like and even put them into Categories. Each tab can be configured to be opened in an iframe or in a new window. In your Settings in Tab Editor, it will list all your current tabs. From this screen you can add, delete, disable, etc

Rearranging Tabs: Hover over the three dots on the left side of the tabs, click and drag to where you want it.

Home Symbol (See image below): This will take you to the Homepage setting based on a best guess of your tab name.

Category: Group tabs together so you can collapse them (set up your categories in the Categories tab below Tab Editor)

Group: Minimum Group that the tab should be shown to. Usually should match ServerAuth if you are using it.

After reading about how Server Authentication works, next we will need to set up the rewriting directive.

You will need to modify your location block. Associated with your site. In Linux, this is typically located at /etc/nginx/sites-available/domain.com.conf

There is already a preconfigured file for this. Find the organizr-auth.subfolder.conf.sample and edit it the same way you did for your main Organizr file and remove the .sample.

For subfolders, just add one of the auth_request lines into the subfolder config with the groups as explained above.

For subdomains, add the auth_request same as you would for a subfolder and add an include for the file such as:

Organizr comes with integrated error pages, they have to be configured in the webserver.

It accepts most error codes, and can do a redirect when the user has acknowledged the error.

The full Syntax for the error page is:

Once you have installed Organizr, the first page that you are presented with is the Wizard page. Here you will enter which License type you want to use along with creating the Admin's credentials.

This is where you would choose if this is for Personal Use of Business use,

Summary

This seems to be coming up more frequently lately. The Organizr logs will look like there was a successful login. If you are reverse proxying Organizr, you may see the following error in your NGINX logs:

2020/05/12 15:52:05 [error] 439#439: *1502 upstream sent too big header while reading response header from upstream, client: 10.0.10.50, server: org.*, request: "POST /api/v2/login HTTP/2.0", upstream: "http://172.18.0.5:80/api/v2/login", host: "domain.com", referrer: "https://domain.com/"

Solution

With a reverse proxy, this seems to be a two step process to fix. If you're not using a reverse proxy skip to the next one. First adding (or increasing the limits if you have this set already, check your proxy.conf) like the following:

The second part and the part if you're not reverse proxying and just running it native, you may see this in the logs:

And this needs to go in the NGINX config where your Organizr is in the PHP block (if you are on the new organizr/organizr container, we have added this now):

Summary

The HealthChecks Homepage item allows you to see all your health checks on your page at a quick glance.

Setting up

Enable

When setting up the homepage item, the first option is to enable it, do that by toggling the Enable Switch. After that you need to set the Minimum Authentication group that will be able to use this item.

If you already went through the or setup you will have these next fields already saved, if not, you can hit set those values using the provided buttons.

Head over to and create an account. Once created head over to User Menu and select Project Settings to copy your API Key.

Enable the API and once enabled click on Show API Keys

Copy the API key (Top one) and paste into Organizr

You can setup logo/images for the checks if you add an images URL to the tags section for that check

To achieve this, you need to create a page file named anything you want inside the pages folder in the data folder. The data folder is located in the root folder of Organizr.

Once you have created a blank page, you may paste this skeleton code to get you started:

• You need to change the first instance of name_here

Summary

The first component needed for Organizr to run is a webserver.

Server Authentication will allow you to secure any/all location blocks at your web server/proxy level, only allowing authenticated Organizr users or administrators access. The result of enabling this feature will disallow users from going to https://domain.com/sonarr directly without authenticating with Organizr first.

There are two methods you may use to enable authorization, via the Organizr authorization API or using OAuth / JWT tokens.

The Organizr authorization API method has the drawback of making calls to Organizr's authorization API for each and every HTTP request made against your protected location blocks, therefore impacting performance.

The Oauth / JWT Token method allows you to securely trust the Organizr authentication simply based on the JWT token passed in your authenticated requests cookies. It does not require any extra roundtrip to the Organizr API, nor the rewrite directives.

To utilize the block add auth_request /organizr-auth/$;