majomi/intro-skipper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation and changelog

Browse Source
This commit is contained in:
ConfusedPolarBear 2022-06-16 21:00:57 -05:00
parent 25783a1953
commit 0808112dfa
5 changed files with 66 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -13,6 +13,10 @@
* Report failure to the UI if the episode analysis queue is empty
* Allow customizing degrees of parallelism
* Warning: Using a value that is too high will result in system instability
* Remove restart requirement to change auto skip setting
* Rewrite startup enqueue
* Fix deadlock issue on Windows (nyanmisaka)
* Improve skip intro button styling & positioning (Fallenbagel)
## v0.1.0.0 (2022-06-09)
* Add option to automatically skip intros

9
README.md
View File

@ -21,12 +21,10 @@ Show introductions will only be detected if they are:
* Located within the first 25% of an episode, or the first 10 minutes, whichever is smaller
* At least 20 seconds long
## Step 1: Optional: install the modified web interface
## Step 1: Optional: use the modified web interface
While this plugin is fully compatible with an unmodified version of Jellyfin 10.8.0, using a modified web interface allows you to click a button to skip intros. If you skip this step and do not use the modified web interface, you will have to enable the "Automatically skip intros" option in the plugin settings.
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**.
2. Follow the plugin installation steps below
Instructions on how to switch web interface versions are located [here](docs/web_interface.md).
## Step 2: Install the plugin
1. Add this plugin repository to your server: `https://raw.githubusercontent.com/ConfusedPolarBear/intro-skipper/master/manifest.json`
@ -39,9 +37,6 @@ While this plugin is fully compatible with an unmodified version of Jellyfin 10.
6. After a season has completed analyzing, play some episodes from it and observe the results
1. Status updates are logged before analyzing each season of a show
## Containerless installation
If you do not run Jellyfin as a container and want to use the skip intro button, you will need to follow the [native installation](docs/native.md) instructions.
## Documentation
Documentation about how the API works can be found in [api.md](docs/api.md).

6
docs/native.md
View File

@ -8,7 +8,7 @@
## Instructions
1. Download the latest modified web interface from the releases tab and either:
1. Serve the web interface directly from your Jellyfin server, or
2. Serve the web interface using an external web server
3. The corresponding source code can be found in this [fork](https://github.com/ConfusedPolarBear/jellyfin-web/tree/intros)
1. Serve the web interface using an external web server, or
2. Serve the web interface directly from your Jellyfin server (**make a backup** of the original version first)
1. On Linux, the web interface is located in `/usr/share/jellyfin/web/`
2. Follow the plugin installation steps from the readme

25
docs/release.md Normal file
View File

@ -0,0 +1,25 @@
# Release procedure
## Run tests
1. Run unit tests with `dotnet test`
2. Run end to end tests with `JELLYFIN_TOKEN=api_key_here python3 main.py`
## Release plugin
1. Update and commit latest changelog and manifest
2. Tag latest commit **without pushing**
3. Build release DLL with `dotnet build -c Release`
4. Zip release DLL
5. Test plugin manifest
1. Replace manifest URL with local IP address
2. Serve release ZIP and manifest with `python3 -m http.server`
3. Test updating plugin
6. Push tag
7. Create release on GitHub with the following files:
1. Archived plugin DLL
2. Latest web interface
## Release container
1. Run publish container action

32
docs/web_interface.md Normal file
View File

@ -0,0 +1,32 @@
# Using the modified web interface
If you run Jellyfin as a container, there are two ways of using the modified web interface:
1. Mounting the new interface to your existing Jellyfin container
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 the latest compiled version of the web interface from [the releases tab](https://github.com/ConfusedPolarBear/intro-skipper/releases/download/v0.0.1/jellyfin-web_10.8.0+3522b61.tar.gz) (or compile [from source](https://github.com/ConfusedPolarBear/jellyfin-web/tree/intros))
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`. Example docker-compose snippet:
```yaml
services:
jellyfin:
ports:
- '8096:8096'
volumes:
- '/full/path/to/extracted/archive/dist:/jellyfin/jellyfin-web:ro' # <== add this line
- '/config:/config'
- '/media:/media:ro'
image: 'jellyfin/jellyfin:10.8.0'
```
## 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).