bradinfluence
f839b12474
- Add CloudronManifest.json with app configuration - Add Dockerfile with Node.js 22 support and multi-stage build - Add start.sh script for runtime initialization - Add icon.png for the app - Update README.md with installation and usage instructions - Configure config directory symlink to /app/data for persistent storage
108 lines
3.1 KiB
Markdown
108 lines
3.1 KiB
Markdown
# cloudron-jellyseer
|
|
|
|
Jellyseerr packaged for Cloudron. Jellyseerr is a free and open source software application for managing requests for your media library. It works with Jellyfin, Plex, and Emby.
|
|
|
|
## Introduction
|
|
|
|
This repository provides a Cloudron package for [Jellyseerr](https://github.com/Fallenbagel/jellyseerr), allowing you to easily deploy and manage Jellyseerr on your Cloudron instance.
|
|
|
|
## Prerequisites
|
|
|
|
You need to install Cloudron CLI: [here](https://docs.cloudron.io/packaging/cli/).
|
|
After installation, connect the CLI to your Cloudron instance.
|
|
|
|
## Installation
|
|
|
|
### Build the App
|
|
|
|
To build the Docker image for Jellyseerr:
|
|
|
|
```bash
|
|
cloudron build
|
|
```
|
|
|
|
This will create a Docker image for Jellyseerr tailored for Cloudron.
|
|
|
|
### Install the App
|
|
|
|
To install Jellyseerr on your Cloudron instance:
|
|
|
|
```bash
|
|
cloudron install --image <your-docker-registry>/cloudron-jellyseerr:<version>
|
|
```
|
|
|
|
Replace `<your-docker-registry>` with your Docker registry (e.g., `yourusername` for Docker Hub) and `<version>` with the version tag (e.g., `1.0.0`).
|
|
|
|
**Note**: Always install the application with a specific version tag (not `latest`). Cloudron's internal registry needs a tagged image version to be able to update when new images are available.
|
|
|
|
### Using Pre-built Images
|
|
|
|
If you're using pre-built images from a registry:
|
|
|
|
```bash
|
|
cloudron install --image yourregistry/cloudron-jellyseerr:1.0.0
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Jellyseerr will store its configuration in `/app/data/config` which is automatically persisted by Cloudron's localstorage addon.
|
|
|
|
### First Run
|
|
|
|
1. After installation, access Jellyseerr through your Cloudron dashboard
|
|
2. Complete the initial setup wizard
|
|
3. Connect Jellyseerr to your Jellyfin, Plex, or Emby server
|
|
4. Configure your media request settings
|
|
|
|
## Features
|
|
|
|
- **Media Request Management**: Users can request movies and TV shows
|
|
- **Multi-Server Support**: Works with Jellyfin, Plex, and Emby
|
|
- **User Management**: Built-in user authentication and permissions
|
|
- **Automated Workflows**: Integrates with automation tools like Radarr and Sonarr
|
|
- **Beautiful UI**: Modern, responsive interface
|
|
|
|
## Updating
|
|
|
|
To update Jellyseerr:
|
|
|
|
1. Build a new version:
|
|
```bash
|
|
cloudron build
|
|
```
|
|
|
|
2. Push the new image to your registry:
|
|
```bash
|
|
docker push yourregistry/cloudron-jellyseerr:<new-version>
|
|
```
|
|
|
|
3. Update the app on Cloudron:
|
|
```bash
|
|
cloudron update --image yourregistry/cloudron-jellyseerr:<new-version>
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
### App Won't Start
|
|
|
|
- Check the app logs in Cloudron dashboard
|
|
- Ensure the config directory has proper permissions
|
|
- Verify that port 5055 is available
|
|
|
|
### Configuration Issues
|
|
|
|
- Configuration is stored in `/app/data/config`
|
|
- You can access the file manager through Cloudron's app settings
|
|
- Ensure Jellyseerr has write permissions to the config directory
|
|
|
|
## Resources
|
|
|
|
- [Jellyseerr GitHub](https://github.com/Fallenbagel/jellyseerr)
|
|
- [Jellyseerr Documentation](https://docs.jellyseerr.dev/)
|
|
- [Cloudron Documentation](https://docs.cloudron.io/)
|
|
- [Cloudron Packaging Guide](https://docs.cloudron.io/packaging/)
|
|
|
|
## License
|
|
|
|
MIT License - See [LICENSE](LICENSE) file for details.
|