Skip to content

Commit

Permalink
Add documentation and prepare for proper first release
Browse files Browse the repository at this point in the history
  • Loading branch information
Schaka committed Jan 15, 2024
1 parent d6f7840 commit a277191
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,6 @@ If you don't manage your container via a GUI like portainer, try `docker logs ja
You NEED [Maintainerr for Plex](https://github.com/jorenn92/Maintainerr) or Janitorr for Jellyfin.
It's THE solution for cleaning up your server and freeing up space before you run into issues.

### Disclaimer
- Jellyfin does NOT have a collection API like Plex, recreating all of Maintainerr is not possible
- Management via the Jellyfin UI is simply not possible at this point
- Jellyfin does NOT provide viewing stats like Jellyfin, so we go by file age
- Jellyfin and Jellyseerr are not required, but if you don't supply them, you may end up with orphaned folders, metadata, etc
- To disable Jellyfin/Jellyseerr, you need to entirely delete their client info from the config file
- **It does NOT YET check whether certain media is still seeding before deleting it**
- It does ALSO NOT YET create "Leaving Soon" libraries in Jellyfin, so filesystem access is NOT required yet

## Features
- Dry-run mode to investage changes before committing to any deletion
- Configure expiration times for your media in Jellyfin, Jellyseerr, Radarr, and Sonarr
Expand All @@ -40,6 +31,15 @@ It's THE solution for cleaning up your server and freeing up space before you ru
- Season by season removal for TV shows
- Clear requests from Jellyseerr

### Disclaimer
- Jellyfin does NOT have a collection API like Plex, recreating all of Maintainerr is not possible
- Management via the Jellyfin UI is simply not possible at this point
- Jellyfin does NOT provide viewing stats like Jellyfin, so we go by file age
- Jellyfin and Jellyseerr are not required, but if you don't supply them, you may end up with orphaned folders, metadata, etc
- To disable Jellyfin/Jellyseerr, you need to entirely delete their client info from the config file
- **It does NOT YET check whether certain media is still seeding before deleting it**
- It does ALSO NOT YET create "Leaving Soon" libraries in Jellyfin, so filesystem access is NOT required yet

## Setup
Currently, the code is only published as a docker image to [DockerHub](https://hub.docker.com/repository/docker/schaka/janitorr/general). If you cannot use Docker, you're out of luck for now.

Expand Down

0 comments on commit a277191

Please sign in to comment.