Migration Guide

Search…
Migration Guide
Migrating from certain versions requires changes on your part
Summary
Sometimes Organizr needs to be updated on the backend which causes user interaction that needs to be completed prior to the upgrade.
Version 2.0 -> Version 2.1
Prerequisites
DOCKER USERS
First of all, if you are using an Organizr docker container, please make sure you are using the new Organizr Image:
GitHub - Organizr/docker-organizr: Docker image for Organizr
GitHub
1
organizr:
2
    container_name: organizr
3
    hostname: organizr
4
    image: organizr/organizr
5
    restart: unless-stopped
6
    ports:
7
        - 80:80
8
    volumes:
9
        - /home/organizr:/config
10
    environment:
11
        - fpm=true #true or false | using true will provide better performance
12
        - branch=v2-master #v2-master or #v2-develop
13
        - PUID=1000
14
        - PGID=1000
15
        - TZ=${TZ}
Copied!
If you are using or you have now switched over to this container, you will not need to add the new api location block as that has been added for you in the container image.  If you are using Nginx's Auth_Request module, you will need to update that address by following these instructions: HERE​
Note: the branch variable will take short hand such as master instead of v2-master and dev or develop instead of v2-develop as may be seen in the tag migration examples.
NON-DOCKER USERS
We will need to update your webserver to include the new API location block.
API Location Block
This is only needed on the actual webserver that is running Organizr - This also assumes Organizr is proxied to root directory - You will need to add directory to example if it is not running at root directory.
If you reverse proxy Organizr to another Webserver - do not add to that server. Only add to the webserver that hosts Organizr.
Nginx
Please include this location block within the server block that houses Organizr.
1
location /api/v2 {
2
	try_files $uri /api/v2/index.php$is_args$args;
3
}
Copied!
 If you are using Nginx's Auth_Request module, you will need to update that address by following these instructions:
Nginx Server Authentication
Apache
1
RewriteEngine On
2
RewriteBase /api/v2
3
RewriteCond %{REQUEST_FILENAME} !-f
4
RewriteCond %{REQUEST_FILENAME} !-d
5
RewriteRule ^ /api/v2/index.php [QSA,L]
Copied!
Caddy v2
1
rewrite /api/v2/* /api/v2/index.php?{query}
Copied!
Caddy v1
1
rewrite / {
2
   regexp ^/api/v2/*
3
   to /api/v2/index.php?{query}
4
}
Copied!
IIS
1.Head to IIS webpage Settings
2.Import Rules
3.Paste code below and Apply
1
RewriteEngine On
2
RewriteCond %{REQUEST_FILENAME} !-f
3
RewriteCond %{REQUEST_FILENAME} !-d
4
RewriteRule ^ /api/v2/index.php [QSA,L]
Copied!
Also make sure you allow the following HTTP Methods:
1.Put
2.Delete
3.Options
Nginx Auth_Request
You will need to update your url for the auth_request module.
Notice the position of the ? and & signs
Subdirectories
1
Change from this line:
2
rewrite ^/auth-(.*) /api/?v1/auth&group=$1;
3
​
4
Change to this line:
5
rewrite ^/auth-(.*) /api/v2/auth/$1;
Copied!
The complete config block will look like this:
1
location ~ /auth-(.*) {
2
	rewrite ^/auth-(.*) /api/v2/auth/$1;
3
}
Copied!
Subdomains
 Do not just copy/paste this. This is just an example of how it should look. organizr-upstream is probably not the same as your setup.
1
Change from this line:
2
proxy_pass http://organizr-upstream/api/?v1/auth&group=$1;
3
​
4
Change to this line:
5
proxy_pass http://organizr-upstream/api/v2/auth/$1;
Copied!
The complete config block will look like this:
1
location ~ ^/auth-(.*) {
2
	## Has to be local ip or local DNS name or if Proxied use proxy address
3
	proxy_pass http://organizr-upstream/api/v2/auth/$1;
4
	proxy_pass_request_body off;
5
	proxy_set_header Content-Length "";
6
}
Copied!
Jellyfin & Emby
We have separated Jellyfin from Emby. Please head to the homepage item section and fix accordingly. If you are using Jellyfin for authentication, please edit the Authentication settings and input your URL and Token respectively.
Troubleshooting
Nothing loading at all/Blank Organizr
If your Organizr is totally blank or you see 404's in the Browser Console (F12) then more than likely you did not perform the API location block addition at all or correctly.  Please refer to the changes above for the appropriate webserver.
Settings/Homepage won't load
If you cannot access the settings/homepage page in Organizr - more than likely the tab url updater didn't run successfully.
Head over to your browser and type in the following:
get
http://organizr-location
/api/v2/update/migrate/2.1.0
Migration API Endpoint
Now you can go back to Organizr and reload if you haven't and check the settings/homepage page.
Custom Homepage Items Missing
There was a type on the there config item keys.  There are a total of 4 of them.  Go to the file /api/config/config.php and change these four keys from the left side of the image to the right side of the image.  All that was missing was the letter e
Update available even though up to date
Next - 🌍 Development
Plugin Development
Last modified 8mo ago
Export as PDF
Copy link
Contents
Summary
Version 2.0 -> Version 2.1
Migration API Endpoint