Install and Update tutorials with screenshots
6
Home.md
@@ -6,6 +6,12 @@ A Jellyfin **channel plugin** that shows your Floatplane subscriptions (creators
|
|||||||
- Install: Dashboard → Plugins → Repositories → add `https://gitea.brasse-pc.eu/brasse/jellyfin-plugin-floatplane/releases/download/latest/manifest.json`, or run `install-pi5.sh` from the release.
|
- Install: Dashboard → Plugins → Repositories → add `https://gitea.brasse-pc.eu/brasse/jellyfin-plugin-floatplane/releases/download/latest/manifest.json`, or run `install-pi5.sh` from the release.
|
||||||
- Built for **Jellyfin 10.10.x** (.NET 8, `targetAbi 10.10.0.0`). One AnyCPU DLL for x64 and arm64 (Pi5).
|
- Built for **Jellyfin 10.10.x** (.NET 8, `targetAbi 10.10.0.0`). One AnyCPU DLL for x64 and arm64 (Pi5).
|
||||||
|
|
||||||
|
## Tutorials
|
||||||
|
|
||||||
|
- [Install tutorial](Install) — add the repository, install from the catalogue, restart, paste the session cookie (with screenshots)
|
||||||
|
- [Update tutorial](Update) — automatic updates, updating through the catalogue, `install.sh`
|
||||||
|
- [Floatplane API notes](Floatplane-API)
|
||||||
|
|
||||||
## What's new (2026-10-25, v0.2)
|
## What's new (2026-10-25, v0.2)
|
||||||
|
|
||||||
- **"All videos" folder** per creator: every sub-channel's videos in release order
|
- **"All videos" folder** per creator: every sub-channel's videos in release order
|
||||||
|
|||||||
102
Install.md
Normal file
@@ -0,0 +1,102 @@
|
|||||||
|
# Install tutorial (Jellyfin 10.10.x)
|
||||||
|
|
||||||
|
Step-by-step installation of the Floatplane plugin through Jellyfin's own plugin
|
||||||
|
catalogue. Every screenshot is from a stock Jellyfin 10.10.7 (linuxserver.io image).
|
||||||
|
You need to be a Jellyfin **administrator**. Total time: about two minutes.
|
||||||
|
|
||||||
|
Other ways to install (no screenshots): the `install.sh` script and a manual unzip —
|
||||||
|
see the [README](https://gitea.brasse-pc.eu/brasse/jellyfin-plugin-floatplane#install).
|
||||||
|
|
||||||
|
## 1. Add the plugin repository
|
||||||
|
|
||||||
|
Open **Dashboard → Plugins → Repositories**. The list only contains the default
|
||||||
|
"Jellyfin Stable" repository.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Press the **+** button next to the "Repositories" title. In the dialog, enter any name
|
||||||
|
and this URL:
|
||||||
|
|
||||||
|
```
|
||||||
|
https://gitea.brasse-pc.eu/brasse/jellyfin-plugin-floatplane/releases/download/latest/manifest.json
|
||||||
|
```
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Press **Save**. Jellyfin warns that third-party repositories carry risks — confirm with
|
||||||
|
**Ok**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
The repository now appears in the list.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## 2. Install the plugin from the catalogue
|
||||||
|
|
||||||
|
Open **Dashboard → Plugins → Catalog** and scroll to the **Channels** section. The
|
||||||
|
Floatplane card shows the plugin logo (the catalogue may take a few seconds to load).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Click the card. The plugin page shows the description, the newest revision and the
|
||||||
|
**Install** button.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Press **Install** and confirm the warning with **Install**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## 3. Restart Jellyfin
|
||||||
|
|
||||||
|
Back on **Dashboard → Plugins → My Plugins** the Floatplane card says **Status Restart**:
|
||||||
|
the files are downloaded, but plugins are only loaded when the server starts.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Go to **Dashboard**, press **Restart** and confirm.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Wait half a minute and log in again. **My Plugins** now shows Floatplane with
|
||||||
|
**Status Active**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> If the Restart button is missing (some Docker set-ups), restart the container instead:
|
||||||
|
> `docker restart jellyfin`.
|
||||||
|
|
||||||
|
## 4. Configure the plugin
|
||||||
|
|
||||||
|
Click the Floatplane card (or its ⋮ menu → Settings). The settings page opens with a
|
||||||
|
status block at the top.
|
||||||
|
|
||||||
|
**Session.** For playback the plugin needs your Floatplane session. Log in at
|
||||||
|
floatplane.com in your browser, open the developer tools (F12) → *Application*
|
||||||
|
(Chrome/Edge) or *Storage* (Firefox) → *Cookies* → `https://www.floatplane.com`, copy
|
||||||
|
the **Value** of the cookie named `sails.sid` and paste it here. Press
|
||||||
|
**Validate cookie** — the plugin answers with your user name and subscriptions.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
**Extra creators** is optional: creators you are not subscribed to but want to browse
|
||||||
|
(public listings work without a session, playback does not). The example uses
|
||||||
|
`linustechtips`.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Press **Save** at the bottom. The status block reloads and lists the creators the plugin
|
||||||
|
found, with their sub-channels.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## 5. Browse
|
||||||
|
|
||||||
|
Go to the home screen: a **Floatplane** tile is now under *My Media*. Open it to see the
|
||||||
|
creators, then "All videos" and the sub-channels. Playback needs the session from step 4.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Next: [Update tutorial](Update) · [Floatplane API notes](Floatplane-API) ·
|
||||||
|
[Full usage guide](https://gitea.brasse-pc.eu/brasse/jellyfin-plugin-floatplane/src/branch/master/doc/usage.md)
|
||||||
83
Update.md
Normal file
@@ -0,0 +1,83 @@
|
|||||||
|
# Update tutorial
|
||||||
|
|
||||||
|
How to get a newer version of the Floatplane plugin. Three ways, from least to most
|
||||||
|
manual. All of them keep your settings (the configuration file is separate from the
|
||||||
|
plugin folder).
|
||||||
|
|
||||||
|
## Automatic (default)
|
||||||
|
|
||||||
|
Jellyfin's scheduled task **Update Plugins** runs every night and installs newer
|
||||||
|
versions of plugins that come from a configured repository — the Floatplane plugin
|
||||||
|
ships with `autoUpdate` enabled. After an automatic update the plugin shows
|
||||||
|
**Status Restart** in *My Plugins* until Jellyfin is restarted, so in practice: when
|
||||||
|
you notice "Restart", restart the server.
|
||||||
|
|
||||||
|
You can run the task by hand under **Dashboard → Scheduled Tasks → Update Plugins** (the
|
||||||
|
▶ button).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Through the catalogue (manual, with screenshots)
|
||||||
|
|
||||||
|
**My Plugins** shows the installed version — here `0.2.0.0`.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Open **Dashboard → Plugins → Catalog**, scroll to **Channels** and click the Floatplane
|
||||||
|
card. The plugin page lists the newest revision from the repository. If it is newer than
|
||||||
|
what *My Plugins* shows, press **Install**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Confirm the warning.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
*My Plugins* now shows both versions: the new one with **Status Restart**, the old one
|
||||||
|
as **Superceded**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Restart Jellyfin (**Dashboard → Restart**, or `docker restart jellyfin`). After the
|
||||||
|
restart the new version is **Active**; the old folder can be removed from the card's
|
||||||
|
⋮ menu → *Uninstall* (optional — Jellyfin ignores superseded versions).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## With the install script (Docker / native hosts)
|
||||||
|
|
||||||
|
The script downloads the newest release, verifies the checksum, replaces the plugin
|
||||||
|
folder and restarts Jellyfin. Run it on the host (with `sudo` if the plugin directory
|
||||||
|
needs it); `--dry-run` only prints what it would do.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://gitea.brasse-pc.eu/brasse/jellyfin-plugin-floatplane/releases/download/latest/install.sh | sh -s -- --dry-run
|
||||||
|
curl -fsSL https://gitea.brasse-pc.eu/brasse/jellyfin-plugin-floatplane/releases/download/latest/install.sh | sh
|
||||||
|
```
|
||||||
|
|
||||||
|
Example dry-run output:
|
||||||
|
|
||||||
|
```
|
||||||
|
Floatplane plugin 0.2.0.5 (release latest)
|
||||||
|
package: https://gitea.brasse-pc.eu/brasse/jellyfin-plugin-floatplane/releases/download/latest/floatplane_0.2.0.5.zip
|
||||||
|
checksum: b5e6b689...
|
||||||
|
install: /srv/docker/jellyfin/data/plugins/Floatplane_0.2.0.5
|
||||||
|
remove: /srv/docker/jellyfin/data/plugins/Floatplane_0.2.0.0
|
||||||
|
owner: 1000:1000
|
||||||
|
restart: docker restart jellyfin
|
||||||
|
dry run - nothing changed
|
||||||
|
```
|
||||||
|
|
||||||
|
Variables: `TAG` (default `latest`, or `vX.Y.Z`), `JELLYFIN_CONTAINER` (default
|
||||||
|
`jellyfin`; empty = native install), `JELLYFIN_CONFIG_DIR` (host path of the container's
|
||||||
|
`/config`; read from `docker inspect` when omitted), `PLUGINS_DIR` (override the
|
||||||
|
detected plugin directory), `PUID`/`PGID`.
|
||||||
|
|
||||||
|
## Which version is installed?
|
||||||
|
|
||||||
|
*My Plugins* shows the version under the plugin name, and the top of the plugin's
|
||||||
|
settings page says `Plugin x.y.z.n`. Releases are listed at
|
||||||
|
https://gitea.brasse-pc.eu/brasse/jellyfin-plugin-floatplane/releases — `latest` always
|
||||||
|
carries the newest build from `master`, `vX.Y.Z` tags are versioned releases.
|
||||||
|
|
||||||
|
See also: [Install tutorial](Install) · [Home](Home)
|
||||||
BIN
img/install-01-repositories.png
Normal file
|
After Width: | Height: | Size: 18 KiB |
BIN
img/install-02-add-repository.png
Normal file
|
After Width: | Height: | Size: 33 KiB |
BIN
img/install-03-confirm-repository.png
Normal file
|
After Width: | Height: | Size: 28 KiB |
BIN
img/install-04-repository-added.png
Normal file
|
After Width: | Height: | Size: 22 KiB |
BIN
img/install-05-catalog.png
Normal file
|
After Width: | Height: | Size: 40 KiB |
BIN
img/install-06-plugin-page.png
Normal file
|
After Width: | Height: | Size: 69 KiB |
BIN
img/install-07-confirm-install.png
Normal file
|
After Width: | Height: | Size: 54 KiB |
BIN
img/install-08-restart-required.png
Normal file
|
After Width: | Height: | Size: 46 KiB |
BIN
img/install-09-restart.png
Normal file
|
After Width: | Height: | Size: 31 KiB |
BIN
img/install-10-active.png
Normal file
|
After Width: | Height: | Size: 46 KiB |
BIN
img/install-11-settings-session.png
Normal file
|
After Width: | Height: | Size: 79 KiB |
BIN
img/install-12-settings-creators.png
Normal file
|
After Width: | Height: | Size: 81 KiB |
BIN
img/install-13-settings-saved.png
Normal file
|
After Width: | Height: | Size: 82 KiB |
BIN
img/install-14-home.png
Normal file
|
After Width: | Height: | Size: 12 KiB |
BIN
img/update-01-current-version.png
Normal file
|
After Width: | Height: | Size: 46 KiB |
BIN
img/update-02-plugin-page.png
Normal file
|
After Width: | Height: | Size: 68 KiB |
BIN
img/update-03-confirm.png
Normal file
|
After Width: | Height: | Size: 54 KiB |
BIN
img/update-04-restart-required.png
Normal file
|
After Width: | Height: | Size: 46 KiB |
BIN
img/update-05-new-version.png
Normal file
|
After Width: | Height: | Size: 46 KiB |
BIN
img/update-06-update-plugins-task.png
Normal file
|
After Width: | Height: | Size: 33 KiB |