Explain how to install subtitles in Docker #1136
Conversation
Cloudflare Pages deployment
|
|
There is already an existing pull request that is aiming to document this. #1129 |
|
Oh, didn't see that one, what a coincidence then (given it was made at similar time). But... looking at it, I believe my approach is a bit better:
|
|
Actually, I see why that was done, it seems to be because it was written to mount the exact same fonts from host... So I'm also not sure if that's really ideal then, personally I'd want some extra fonts for particular media to be installed just in the container instead of having to pollute the host system with these fonts for no particular reason. I think also most people would host Jellyfin on a Linux server rather than desktop to have these fonts already (or on Windows desktop where it wouldn't apply), plus most people probably download up custom fonts by default by just grabbing their files from somewhere instead of using APT. Plus I don't know if mounting |
|
We would prefer you leave feedback on that PR instead of having 2 competing ones. We generally don't want 2 PRs doing the same thing for documentation unless one of them is abandoned. |
| @@ -113,15 +113,15 @@ Jellyfin uses fonts to render text in many places. | |||
|
|
|||
| ### Server Side System Fonts | |||
|
|
|||
| The system fonts installed on the server are used for burning in subtitles and rendering cover images. How to install them depends on the operating system. | |||
| The system fonts installed on the server are used for burning in subtitles and rendering cover images. How to install them depends on the operating system or container being used. | |||
There was a problem hiding this comment.
| The system fonts installed on the server are used for burning in subtitles and rendering cover images. How to install them depends on the operating system or container being used. | |
| The system fonts installed on the server are used for burning in subtitles and rendering cover images. How to install them depends on the operating system or if a container is being used. | |
|
|
||
| ### Client Side System Fonts | ||
|
|
||
| The system fonts installed on the client devices are used to display the text in the client interface as well as render subtitles for some clients. How to install them depends on the operating system. | ||
|
|
||
| ### Fallback Fonts | ||
|
|
||
| The `Fallback Fonts` option is currently used by the web client to render subtitles only. This can be set to a folder containing fonts for this purpose. These fonts are limited to a total size of 20MB. Lightweight formats optimized for web like woff2 are recommended. A tool to convert normal TrueType (`.ttf`) and OpenType (`.otf`) fonts to woff2 can be found [in their repo](https://github.com/google/woff2). | ||
| The `Fallback Fonts` option is currently used by the web client to render subtitles only. This can be set to a folder on the server containing fonts for this purpose, which will then be streamed to the client during playback, negating the need to manually install them to all clients locally. These fonts are limited to a total size of 20 MB. Lightweight formats optimized for web like woff2 are recommended. A tool to convert normal TrueType (`.ttf`) and OpenType (`.otf`) fonts to woff2 can be found [in their repo](https://github.com/google/woff2). |
There was a problem hiding this comment.
This is inaccurate. The clients that use this will not use local fonts, and the clients that use local fonts will not use this
Server-side fonts are used for subtitle burn-in, so it might be of interest to users to install custom fonts there.
Apparently it's enough to mount a custom font directory into for example
/usr/local/share/fonts/custom(thecustompart is arbitrary name, but the primary/usr/local/share/fontsfolder shouldn't be mounted itself as it also has.uuidfile there, so a subdir needs to be created.And once that's done, the fontcache will apparently be automatically updated on container restart. So that just works out of the box with no changes to Jellyfin required at all.
Also did some changes to section where font types are explained.
This is meant to both suggest people to look into Docker docs if they use Docker container, and to also not have some newbie install fonts on host OS while using a container and be confused why that doesn't work, this slight addition will hopefully prevent that.
Also added some things to Fallback Fonts section to hopefully make it clear how that feature works and in which direction the fonts go there.