Skip to content

Commit

Permalink
Remove content from README and replace with contribution instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
@BrenekH
BrenekH committed Sep 22, 2024
1 parent 852f73e commit fec7f9a
Showing 1 changed file with 22 additions and 60 deletions.
82 changes: 22 additions & 60 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,71 +2,33 @@

<p>
<a href="https://hits.seeyoufarm.com"><img alt="Hits" src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FLocatarr%2FLocatarr&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false" /></a>
<a href="https://github.com/Locatarr/Locatarr/issues"><img alt="contributions welcome" src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat" /></a>
<a href="https://github.com/Locatarr/locatarr.github.io/issues"><img alt="contributions welcome" src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat" /></a>
</p>

Locating *Arr services and aggregating them into a single list.
Feel free to open a [PR](https://github.com/Locatarr/Locatarr/pulls) with apps that aren't listed!
Feel free to open a [PR](https://github.com/Locatarr/locatarr.github.io/pulls) with apps that aren't listed!

**See Also:** [What Happened to rustyshackleford36/locatarr](https://github.com/Locatarr/Locatarr/discussions/3)
## Contributing

## *ARR Services
There are 2 json files in root of the repository ([`arr-services.json`](arr-services.json) and [`other-helpful-apps.json`](other-helpful-apps.json)) which contain the data for the tables that are shown on [locatarr.github.io](https://locatarr.github.io).
In order to add or modify the tables on the website, simply fork the repository, update the appropriate json file, and open a new PR into the `master` branch.
Order doesn't matter in the JSON file as the applications are sorted by name before being inserted into the website.

| **Service** | **Usage** | **Github** | **Reddit** |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ------------------------------------------- |
| Addarr | Telegram bot for Sonarr/Radarr | [Waterboy1602/Addarr](https://github.com/Waterboy1602/Addarr) | |
| Autobrr | Modern torrent and Usenet download tool with automation inspired by Trackarr, Autodl-irssi, and Flexget | [autobrr/autobrr](https://github.com/autobrr/autobrr) | |
| Bazarr | Automates & manages **subtitles** | [morpheus65535/bazarr](https://github.com/morpheus65535/bazarr) | |
| Bobarr | Radarr+Sonarr+Jackett+VPN | [iam4x/bobarr](https://github.com/iam4x/bobarr) | |
| Cardigann | Alternative to Jackett | [cardigann/cardigann](https://github.com/cardigann/cardigann) | |
| Deleterr | Automates deleting inactive and stale media from Plex/Sonarr/Radarr | [rfsbraz/deleterr](https://github.com/rfsbraz/deleterr) | |
| Doplarr | Uses modern Discord slash commands and components, which provides a clean, performant UI on desktop and mobile. | [kiranshila/Doplarr](https://github.com/kiranshila/Doplarr) | |
| Elsewherr | See disclaimer on page. See if your movies from Radarr are available on a streaming service, and add a tag against the movie if it is. | [Adman1020/Elsewherr](https://github.com/Adman1020/Elsewherr) | |
| Excludarr | Manages you library in Sonarr and Radarr to only consist out of movies and series that are not present on any of the configured streaming providers. | [haijeploeg/excludarr](https://github.com/haijeploeg/excludarr) | |
| Exportarr | AIO Prometheus Exporter for Sonarr, Radarr or Lidarr | [onedr0op/exportarr](https://github.com/onedr0p/exportarr) | |
| Homarr | Customizable browser's home page to interact with your homeserver's Docker containers | [ajnart/homarr](https://github.com/ajnart/homarr) | |
| Jackett | API Support for your favorite torrent trackers. | [Jackett/Jackett](https://github.com/Jackett/Jackett) | [/r/Jackett](http://reddit.com/r/jackett) |
| Janitorr | Cleans your Radarr, Sonarr, Jellyseerr and Jellyfin before you run out of space | [Schaka/janitorr](https://github.com/Schaka/janitorr) | |
| Jellyseerr | Fork of overseerr for jellyfin support. | [Fallenbagel/jellyseerr](https://github.com/Fallenbagel/jellyseerr) | |
| Kapowarr | Automates & manages **comic books** | [Casvt/Kapowarr](https://github.com/Casvt/Kapowarr) | [r/Kapowarr](https://reddit.com/r/Kapowarr) |
| Lidarr | Automates & manages **music** | [lidarr/lidarr](https://github.com/lidarr/lidarr) | [/r/lidarr](http://reddit.com/r/lidarr) |
| Listrr | Automates lists on trakt.tv based on your filters. | [TheUltimateC0der/Listrr](https://github.com/TheUltimateC0der/Listrr) | |
| Logarr | A log consolidation tool written in PHP | [Monitorr/logarr](https://github.com/Monitorr/logarr) | |
| Maintainerr | Maintenance tool for the Plex ecosystem | [jorenn92/Maintainerr](https://github.com/jorenn92/Maintainerr) | |
| Monitorr | A webfront to live display the status of any webapp or service | [Monitorr/Monitorr](https://github.com/Monitorr/Monitorr) | |
| Movearr | Simple CLI tool to perform Sonnar/Radarr moves based on specific criteria. | [l3uddz/movearr](https://github.com/l3uddz/movearr) | |
| Mylarr | Automates & manages **comic books** | [mylar3/mylar3](https://github.com/mylar3/mylar3) | |
| Organizr | HTPC/Homelab Services Organizer | [/causefx/Organizr](https://github.com/causefx/Organizr) | [/r/Organizr](http://reddit.com/r/organizr) |
| Overseerr | FOSS app for managing requests for your media library. Integrates with your existing services | [sct/overseerr](https://github.com/sct/overseerr) | |
| Posterr | Media display for Plex, Sonarr, and Radarr | [petersem/posterr](https://github.com/petersem/poster) | |
| Posterizarr | Automated poster maker for Plex/Jellyfin/Emby. | [fscorrupt/Posterizarr](https://github.com/fscorrupt/Posterizarr) | |
| prefetcharr | Let Sonarr fetch the next season of a show you are watching on Jellyfin/Emby/Plex. | [p-hueber/prefetcharr](https://github.com/p-hueber/prefetcharr) | |
| Prowlarr | Indexer Manager that syncs with other *arrs. | [Prowlarr/Prowlarr](https://github.com/Prowlarr/Prowlarr) | [/r/Prowlarr](http://reddit.com/r/prowlarr) |
| Radarr | Automates & manages **movies** | [Radarr/Radarr](https://github.com/Radarr/Radarr) | [/r/Radarr](http://reddit.com/r/Radarr) |
| Readarr | Automates & manages **ebooks** | [Readarr/Readarr](https://github.com/Readarr/Readarr) | |
| Requestrr | chatbot used to simplify using services like Sonarr/Radarr/Ombi via chat | [Darkalfx/requestrr](https://github.com/darkalfx/requestrr) | |
| Rollarr | Automatic Pre-roll script with a GUI for Plex | [TheHumanRobot/Rollarr](https://hub.docker.com/r/thehumanrobot/rollarr) | |
| Searcharr | Sonarr & Radarr Telegram Bot | [toddrobb99/searcharr](https://github.com/toddrob99/searcharr) | |
| Sonarr | Automates & manages **TV series** | [Sonarr/Sonarr](https://github.com/Sonarr/Sonarr) | [/r/Sonarr](http://reddit.com/r/sonarr) |
| Swaparr | An app that watches dowloads grabbed by an *arr app for stalled ones to be deleted. | [ThijmenGThN/swaparr](https://github.com/ThijmenGThN/swaparr) | |
| Syncarr | Sync two Radarr/Sonarr/Lidarr servers via API | [syncarr/syncarr](https://github.com/syncarr/syncarr) | |
| Tdarr | FFmpeg/HandBrake + video health checking | [HaveAGitGat/Tdarr](https://github.com/HaveAGitGat/Tdarr) | [/r/Tdarr](http://reddit.com/r/tdarr) |
| Traktarr | Add new media based on Trakt lists | [l3uddz/traktarr](https://github.com/l3uddz/traktarr) | |
| UmlautAdaptarr | A tool to work around Sonarr, Radarr, Lidarr and Readarrs problems with foreign languages | [PCJones/UmlautAdaptarr](https://github.com/PCJones/UmlautAdaptarr) | |
| Unpackerr | Extracts archives from watch folders for import into other ARR apps | [davidnewhall/unpackerr](https://github.com/davidnewhall/unpackerr) | |
## How the system works

## Other Helpful Apps
This repository utilizes GitHub Actions & Jekyll to build a fully rendered, static webpage to be hosted on GitHub Pages.

| **Service** | **Usage** | **Github** | **Reddit** |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| Gaps | Searches through your Plex Server for all movies, then queries for known movies in the same collection. | [JasonHHouse](https://github.com/JasonHHouse/gaps) | |
| Jackett2Telegram | A self-hosted Telegram Python Bot that dumps posts from Jackett RSS feeds to a Telegram chat. | [danimart1991/jackett2telegram](https://github.com/danimart1991/jackett2telegram) | |
| Jellyfin | Free Software Media System | [jellyfin/jellyfin](https://github.com/jellyfin) | [/r/Jellyfin](http://www.reddit.com/r/jellyfin) |
| Mayhem's Star Scripts | Scripts to make using the starr apps easier, actively being updated | [MayhemBill/Starr-Scripts](https://github.com/MayhemBill/Starr-Scripts) | |
| Ombi | Manages media requests | [tidusjar/Ombi](https://github.com/tidusjar/Ombi) | [/r/Ombi](http://www.reddit.com/r/ombi) |
| Radarr AutoDelete | Simple script, which deletes movies with a specific tag after a certain amount of days | [JCSynthTux/radarr_autodelete](https://github.com/JCSynthTux/radarr_autodelete) | |
| Radarr-Striptracks | adds a script to automatically strip out unwanted audio and subtitle streams, keeping only the desired languages. | [linuxserver/docker-mods/tree/radarr-striptracks](https://github.com/linuxserver/docker-mods/tree/radarr-striptracks) | |
| Sickbeard MP4 Automator | Automatically converts media files downloaded by various programs to a standardized format, and tags them with the appropriate metadata from TMDB if the container supports tagging. | [mdhiggins/sickbeard_mp4_automator](https://github.com/mdhiggins/sickbeard_mp4_automator) | |
| theme.park | Themes for all the *arrs | [gilbn/theme.park](https://github.com/gilbN/theme.park) | |
| TrailerDownloader | Downloads all missing trailers for movies in your Plex library. | [taylorbobaylor/TrailerDownloader](https://github.com/taylorbobaylor/TrailerDownloader) | |
| Unmanic | Transcodes your library | [josh5/unmanic](https://github.com/Josh5/unmanic) | |
In order to generate markdown from the JSON files located in the repo, a [custom GitHub action](https://github.com/Locatarr/markdown-table-generator) reads in each JSON file and emits a markdown table generated from the contents.
The tables are then inserted into a template file which contains all of the static portions of the final website output.

Once the final markdown file is constructed, the [actions/jekyll-build-pages](https://github.com/actions/jekyll-build-pages) utilizes Jekyll to generate a Pages-compatible website which is then uploaded to the Pages environment.

## License

The Locatarr website is licensed under the Apache 2.0 License.

See [the LICENSE file](LICENSE) for details.

## Misc

**See Also:** [What Happened to rustyshackleford36/locatarr](https://github.com/Locatarr/locatarr.github.io/discussions/3)

0 comments on commit fec7f9a

Please sign in to comment.