Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instuction how to inject clientscript via nginx reverse proxy config #42

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add instuction how to inject clientscript via nginx reverse proxy config #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,22 @@ Jellyscrub on iOS [<b>Single Screenshot, Functions Same as Above</b>]:
<b>NOTE: The client script will fail to inject automatically into the jellyfin-web server if there is a difference in permission between the owner of the web files (root, or www-data, etc.) and the executor of the main jellyfin-server. This often happens because...</b>
* <b>Docker -</b> the container is being run as a non-root user while having been built as a root user, causing the web files to be owned by root. To solve this, you can remove any lines like `User: 1000:1000`, `GUID:`, `PID:`, etc. from the jellyfin docker compose file.
* <b>Install from distro repositories -</b> the jellyfin-server will execute as `jellyfin` user while the web files will be owned by `root`, `www-data`, etc. This can <i>likely</i> be fixed by adding the `jellyfin` (or whichecher user your main jellyfin server runs at) to the same group the jellyfin-web folders are owned by. You should only do this if they are owned by a group other than root, and will have to lookup how to manage permissions on your specific distro.
* <b>Jellyfin behind NGINX reverse proxy -</b> An alternative to the two solutions above is injecting the code into the webclient by using NGINX's [ngx_http_sub_module](https://nginx.org/en/docs/http/ngx_http_sub_module.html) module. This works when using Nginx as reverse proxy in front of Jellyfin (regardless of install method) and does not require any file/owner/permissions changes at all as NGINX simply injects the code dynamically on request.

Example:
```
location = /web/ {
...
# inject Jellyscrub script into the webclient
proxy_set_header Accept-Encoding "";
sub_filter
'</body>'
'<script plugin="Jellyscrub" version="1.0.0.0" src="/Trickplay/ClientScript"></script>
</body>';
sub_filter_once on;
...
}
```
* <b>Alternatively, the script can manually be added to the index.html as described below.</b>

<b>NOTE: If you manually injected the script tag, you will have to manually inject it on every jellyfin-web update, as the index.html file will get overwritten. However, for normal Jellyscrub updates the script tag will not need to be changed as the plugin will return the latest script from /ClientScript</b>
Expand Down