docs: Update README to include Configuration and Troubleshooting sections
This commit is contained in:
63
README.md
63
README.md
@@ -14,13 +14,16 @@ This plugin is based on my manual mod (see the [legacy branch](https://github.co
|
||||
- [Features](#features)
|
||||
- [Overview](#overview)
|
||||
- [Installation](#installation)
|
||||
- [Usage](#usage)
|
||||
- [Configuration](#configuration)
|
||||
- [Automatic Theme Selection](#automatic-theme-selection)
|
||||
- [Build Process](#build-process)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Effects Not Showing](#effects-not-showing)
|
||||
- [Docker Permission Issues](#docker-permission-issues)
|
||||
- [Contributing](#contributing)
|
||||
- [Legacy Manual Installation](#legacy-manual-installation)
|
||||
- [Installation](#installation-1)
|
||||
- [Usage](#usage-1)
|
||||
- [Usage](#usage)
|
||||
- [Additional Directory: Separate Single Seasonals](#additional-directory-separate-single-seasonals)
|
||||
|
||||
---
|
||||
@@ -83,14 +86,14 @@ To install this plugin, you will first need to add the repository in Jellyfin.
|
||||
9. **Restart your Jellyfin server.**
|
||||
10. **You may need to refresh your browser page** (F5 or Ctrl+R) to see the changes.
|
||||
|
||||
## Usage
|
||||
## Configuration
|
||||
|
||||
After installation and restart:
|
||||
|
||||
1. Go to **Dashboard** > **Plugins** > **Seasonals**.
|
||||
2. **Enable Seasonals**: Toggle the plugin on or off.
|
||||
3. **Automatic Selection**:
|
||||
* If enabled, the plugin selects the theme based on the current date (e.g., Snow in Winter, Hearts in February).
|
||||
* If enabled, the plugin selects the theme based on the current date (e.g., Snow in Winter, Hearts in February). See the table below for details.
|
||||
* If disabled, you can manually select a theme from the dropdown list.
|
||||
4. **Save** your settings.
|
||||
5. **Reload your browser page** (F5 or Ctrl+R) to see the changes.
|
||||
@@ -124,6 +127,58 @@ If you want to build the plugin yourself:
|
||||
```
|
||||
4. The compiled DLL and resources will be in bin/Publish.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Effects Not Showing
|
||||
1. **Verify plugin installation**:
|
||||
- Check that the plugin appears in the jellyfin admin panel
|
||||
- Ensure that the plugin is enabled and active
|
||||
|
||||
2. **Clear browser cache**:
|
||||
- Force refresh browser (Ctrl+F5)
|
||||
- Clear jellyfin web client cache (--> mostly you have to clear the whole browser cache)
|
||||
|
||||
### Docker Permission Issues
|
||||
If you encounter the message `Access was denied when attempting to inject script into index.html. Automatic direct injection failed. Automatic direct insertion failed. The system will now attempt to use the File Transformation plugin.` in the log or similar permission errors in Docker:
|
||||
|
||||
**Option 1: Use File Transformation Plugin (Recommended)**
|
||||
|
||||
Seasonals now automatically detects and uses the [File Transformation](https://github.com/IAmParadox27/jellyfin-plugin-file-transformation) plugin (v2.5.0.0+) if it's installed. This eliminates permission issues by transforming content at runtime without modifying files on disk.
|
||||
|
||||
**Installation Steps:**
|
||||
1. Install the File Transformation plugin from the Jellyfin plugin catalog
|
||||
2. Restart Jellyfin
|
||||
3. Seasonals will automatically detect and use it (no configuration needed)
|
||||
4. Check logs to confirm: Look for "Successfully registered transformation with File Transformation plugin"
|
||||
|
||||
**Benefits:**
|
||||
- No file permission issues in Docker environments
|
||||
- Works with read-only web directories
|
||||
- Survives Jellyfin updates without re-injection
|
||||
- No manual file modifications required
|
||||
|
||||
**Option 2: Fix File Permissions**
|
||||
```bash
|
||||
# Find the actual index.html location
|
||||
docker exec -it jellyfin find / -name index.html
|
||||
|
||||
# Fix ownership (replace 'jellyfin' with your container name and adjust user:group if needed)
|
||||
docker exec -it --user root jellyfin chown jellyfin:jellyfin /jellyfin/jellyfin-web/index.html
|
||||
|
||||
# Restart container
|
||||
docker restart jellyfin
|
||||
```
|
||||
|
||||
**Option 3: Manual Volume Mapping**
|
||||
```bash
|
||||
# Extract index.html from container
|
||||
docker cp jellyfin:/jellyfin/jellyfin-web/index.html /path/to/jellyfin/config/index.html
|
||||
|
||||
# Add to docker-compose.yml volumes section:
|
||||
volumes:
|
||||
- /path/to/jellyfin/config/index.html:/jellyfin/jellyfin-web/index.html
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Feel free to contribute to this project by creating pull requests or reporting issues.
|
||||
|
||||
Reference in New Issue
Block a user