diff --git a/docs/native.md b/docs/native.md deleted file mode 100644 index b65acb2..0000000 --- a/docs/native.md +++ /dev/null @@ -1,17 +0,0 @@ -# Native installation - -## Requirements - -* Jellyfin 10.8.0 -* Compiled [jellyfin-web](https://github.com/ConfusedPolarBear/jellyfin-web/tree/intros) interface with intro skip button - -## Instructions - -1. Download and extract the latest modified web interface from [GitHub actions](https://github.com/ConfusedPolarBear/intro-skipper/actions/workflows/container.yml) - 1. Click the most recent action run - 2. In the Artifacts section, click the `jellyfin-web-VERSION+COMMIT.tar.gz` link to download a pre-compiled copy of the web interface. This link will only work if you are signed into GitHub. -2. Make a backup of the original web interface - 1. On Linux, the web interface is located in `/usr/share/jellyfin/web/` - 2. On Windows, the web interface is located in `C:\Program Files\Jellyfin\Server\jellyfin-web` -3. Copy the contents of the `dist` folder you downloaded in step 1 into Jellyfin's web folder -4. Follow the plugin installation steps from the readme diff --git a/docs/web_interface.md b/docs/web_interface.md deleted file mode 100644 index fd77dd6..0000000 --- a/docs/web_interface.md +++ /dev/null @@ -1,44 +0,0 @@ -# Using the modified web interface - -If you run Jellyfin as a container, there are two different ways to use the modified web interface: -1. Mounting the new web interface to your existing Jellyfin container, or -2. Switching container images - -If you do not run Jellyfin as a container, you can follow the [native installation](native.md) instructions. - -## Method 1: mounting the new web interface - -1. Download and extract the latest modified web interface from [GitHub actions](https://github.com/ConfusedPolarBear/intro-skipper/actions/workflows/container.yml) - 1. Click the most recent action run - 2. In the Artifacts section, click the `jellyfin-web-VERSION+COMMIT.tar.gz` link to download a pre-compiled copy of the web interface. This link will only work if you are signed into GitHub. -2. Extract the archive somewhere on your server and make note of the full path to the `dist` folder -3. Mount the `dist` folder to your container as `/jellyfin/jellyfin-web` if using the official container, or `/usr/share/jellyfin/web` if using the linuxserver container. Example docker-compose snippet: -```yaml -services: - jellyfin: - ports: - - '8096:8096' - volumes: - # change `:ro` to `:rw` if you are using a plugin that modifies Jellyfin's web interface from inside the container (such as Jellyscrub) - - '/full/path/to/extracted/dist:/jellyfin/jellyfin-web:ro' # <== add this line if using the official container - - '/full/path/to/extracted/dist:/usr/share/jellyfin/web:ro' # <== add this line if using the linuxserver container - - '/config:/config' - - '/media:/media:ro' - image: 'jellyfin/jellyfin:10.8.0' -``` - -Make sure to clear the browser's cached version of the web interface before testing the skip button. - -### Instructions for Unraid users only - -In the Docker tab, click on the Jellyfin container, then click on "Edit" and enable the advanced view. Under "Extra Parameters", add one of the following: - -* If using the `jellyfin/jellyfin` container: `--volume /full/path/to/extracted/dist:/jellyfin/jellyfin-web:ro` -* If using the `linuxserver/jellyfin` container: `--volume /full/path/to/extracted/dist:/usr/share/jellyfin/web:ro` - -## Method 2: switching container images - -1. Run the `ghcr.io/confusedpolarbear/jellyfin-intro-skipper` container just as you would any other Jellyfin container - 1. If you reuse the configuration data from another container, **make sure to create a backup first**. - -The Dockerfile which builds this container can be viewed [here](../docker/Dockerfile).