mirror of
https://github.com/Radarr/Radarr
synced 2026-01-25 17:01:42 +01:00
docs: update documentation for rebrand
This commit is contained in:
admin
parent
4fd16998d5
commit
038909d097
5 changed files with 112 additions and 118 deletions
37
CHANGELOG.md
Normal file
37
CHANGELOG.md
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
# Changelog
|
||||
|
||||
All notable changes to Logarr are documented in this file.
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### Planned
|
||||
- Book management system with hierarchical structure (Authors, Series, Books)
|
||||
- Audiobook management and integration
|
||||
- Unified search and collection features across media types
|
||||
- Enhanced metadata handling for multi-media formats
|
||||
|
||||
## [0.1.0] - 2024-12-17 - Initial Fork
|
||||
|
||||
### Added
|
||||
- Fork of Radarr v5.x as foundation for unified media manager
|
||||
- Logarr branding throughout application
|
||||
- BuildInfo.cs AppName property set to "Logarr"
|
||||
- UI localization strings (en.json) updated with Logarr branding
|
||||
- Docker labels and metadata identify as "Logarr"
|
||||
- GitHub Actions CI/CD workflow for continuous integration
|
||||
- Docker configuration with multi-architecture support (amd64, arm64)
|
||||
- Project documentation structure and contribution guidelines
|
||||
|
||||
### Changed
|
||||
- **Application Identity** - Radarr → Logarr
|
||||
- Before: Application branded as "Radarr" throughout codebase
|
||||
- After: Application branded as "Logarr" (λόγος - word, reason, unity)
|
||||
- Rationale: Fork establishes distinct identity while retaining proven Radarr architecture as foundation for multi-media manager
|
||||
- Alternative: Maintained Radarr branding (rejected - clarity and distinctness required)
|
||||
- Gotcha: Docker images and configuration references still contain "radarr" in internal paths; changes are UX-facing only to maintain upstream compatibility
|
||||
|
||||
### Notes
|
||||
- Movie functionality preserved from Radarr v5.x
|
||||
- Book and audiobook support planned for future phases
|
||||
- Hierarchical monitoring system (Author → Series → Item) is foundational design goal
|
||||
- Radarr codebase remains the authoritative upstream reference for inherited functionality
|
||||
|
|
@ -59,8 +59,8 @@ representative at an online or offline event.
|
|||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
<development@radarr.video>.
|
||||
reported to the community leaders responsible for enforcement via
|
||||
issues on github.com/Cody-k/logarr.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
|
|
|
|||
|
|
@ -1,21 +1,17 @@
|
|||
|
||||
# How to Contribute
|
||||
|
||||
We're always looking for people to help make Radarr even better, there are a number of ways to contribute.
|
||||
|
||||
# Documentation
|
||||
|
||||
Setup guides, [FAQ](/radarr/faq), the more information we have on the [wiki](https://wiki.servarr.com/radarr) the better.
|
||||
This is a personal project forked from Radarr. We're not actively seeking contributions at this time, but this guide documents the development process.
|
||||
|
||||
# Development
|
||||
|
||||
Radarr is written in C# (backend) and JS (frontend). The backend is built on the .NET6 (and _soon_ .NET8) framework, while the frontend utilizes Reactjs.
|
||||
Logarr is written in C# (backend) and JS (frontend). The backend is built on .NET 8, while the frontend utilizes React.
|
||||
|
||||
## Tools required
|
||||
|
||||
- Visual Studio 2022 or higher is recommended (<https://www.visualstudio.com/vs/>). The community version is free and works (<https://www.visualstudio.com/downloads/>).
|
||||
|
||||
> VS 2022 V17.0 or higher is recommended as it includes the .NET6 SDK
|
||||
> VS 2022 V17.8 or higher is recommended as it includes the .NET 8 SDK
|
||||
{.is-info}
|
||||
|
||||
- HTML/Javascript editor of choice (VS Code/Sublime Text/Webstorm/Atom/etc)
|
||||
|
|
@ -33,8 +29,8 @@ Radarr is written in C# (backend) and JS (frontend). The backend is built on the
|
|||
|
||||
## Getting started
|
||||
|
||||
1. Fork Radarr
|
||||
1. Clone the repository into your development machine. [*info*](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
|
||||
1. Clone the repository: `git clone https://github.com/Cody-k/logarr.git`
|
||||
1. Install dependencies and build as described below
|
||||
|
||||
> Be sure to run lint `yarn lint --fix` on your code for any front end changes before committing.
|
||||
For css changes `yarn stylelint-windows --fix` {.is-info}
|
||||
|
|
@ -60,11 +56,11 @@ The backend solution is most easily built and ran in Visual Studio or Rider, how
|
|||
|
||||
#### Visual Studio
|
||||
|
||||
> Ensure startup project is set to `Radarr.Console` and framework to `net6.0`
|
||||
> Ensure startup project is set to `Radarr.Console` and framework to `net8.0`
|
||||
{.is-info}
|
||||
|
||||
1. First `Build` the solution in Visual Studio, this will ensure all projects are correctly built and dependencies restored
|
||||
1. Next `Debug/Run` the project in Visual Studio to start Radarr
|
||||
1. Next `Debug/Run` the project in Visual Studio to start Logarr
|
||||
1. Open <http://localhost:7878>
|
||||
|
||||
#### Command line
|
||||
|
|
@ -85,31 +81,21 @@ dotnet msbuild -restore src/Radarr.sln -p:Configuration=Debug -p:Platform=Posix
|
|||
|
||||
## Contributing Code
|
||||
|
||||
- If you're adding a new, already requested feature, please comment on [GitHub Issues](https://github.com/Radarr/Radarr/issues) so work is not duplicated (If you want to add something not already on there, please talk to us first)
|
||||
- Rebase from Radarr's develop branch, do not merge
|
||||
- Make meaningful commits, or squash them
|
||||
- Feel free to make a pull request before work is complete, this will let us see where its at and make comments/suggest improvements
|
||||
- Reach out to us on the discord if you have any questions
|
||||
- Add tests (unit/integration)
|
||||
- Commit with \*nix line endings for consistency (We checkout Windows and commit \*nix)
|
||||
- One feature/bug fix per pull request to keep things clean and easy to understand
|
||||
- Use 4 spaces instead of tabs, this is the default for VS 2022 and WebStorm
|
||||
- Make meaningful commits
|
||||
- Add tests (unit/integration) for new features
|
||||
- Commit with \*nix line endings for consistency
|
||||
- Use 4 spaces instead of tabs
|
||||
- Match existing code patterns and style
|
||||
|
||||
## Pull Requesting
|
||||
|
||||
- Only make pull requests to `develop`, never `master`, if you make a PR to `master` we will comment on it and close it
|
||||
- You're probably going to get some comments or questions from us, they will be to ensure consistency and maintainability
|
||||
- We'll try to respond to pull requests as soon as possible, if its been a day or two, please reach out to us, we may have missed it
|
||||
- Each PR should come from its own [feature branch](http://martinfowler.com/bliki/FeatureBranch.html) not develop in your fork, it should have a meaningful branch name (what is being added/fixed)
|
||||
- `new-feature` (Good)
|
||||
- `fix-bug` (Good)
|
||||
- `patch` (Bad)
|
||||
- `develop` (Bad)
|
||||
- Commits should be wrote as `New:` or `Fixed:` for changes that would not be considered a `maintenance release`
|
||||
- Only make pull requests to `develop`, never `master`
|
||||
- Use meaningful feature branch names (what is being added/fixed)
|
||||
- Each PR should contain related changes (one feature/bug fix per PR)
|
||||
|
||||
## Unit Testing
|
||||
|
||||
Radarr utilizes nunit for its unit, integration, and automation test suite.
|
||||
Logarr utilizes nunit for its unit, integration, and automation test suite.
|
||||
|
||||
### Running Tests
|
||||
|
||||
|
|
@ -136,24 +122,11 @@ If you have any questions about any of this, please let us know.
|
|||
|
||||
# Translation
|
||||
|
||||
Radarr uses a self hosted open access [Weblate](https://translate.servarr.com) instance to manage its json translation files. These files are stored in the repo at `src/NzbDrone.Core/Localization`
|
||||
|
||||
## Contributing to an Existing Translation
|
||||
|
||||
Weblate handles synchronization and translation of strings for all languages other than English. Editing of translated strings and translating existing strings for supported languages should be performed there for the Radarr project.
|
||||
|
||||
The English translation, `en.json`, serves as the source for all other translations and is managed on GitHub repo.
|
||||
|
||||
## Adding a Language
|
||||
|
||||
Adding translations to Radarr requires two steps
|
||||
|
||||
- Adding the Language to weblate
|
||||
- Adding the Language to Radarr codebase
|
||||
Translation files are stored in the repo at `src/NzbDrone.Core/Localization`. The English translation, `en.json`, serves as the source for all other translations.
|
||||
|
||||
## Adding Translation Strings in Code
|
||||
|
||||
The English translation, `src/NzbDrone.Core/Localization/en.json`, serves as the source for all other translations and is managed on GitHub repo. When adding a new string to either the UI or backend a key must also be added to `en.json` along with the default value in English. This key may then be consumed as follows:
|
||||
When adding a new string to either the UI or backend, a key must also be added to `src/NzbDrone.Core/Localization/en.json` along with the default value in English. This key may then be consumed as follows:
|
||||
|
||||
> PRs for translation of log messages will not be accepted
|
||||
{.is-warning}
|
||||
|
|
|
|||
120
README.md
120
README.md
|
|
@ -1,90 +1,74 @@
|
|||
# Radarr
|
||||
# Logarr
|
||||
|
||||
[](https://dev.azure.com/Radarr/Radarr/_build/latest?definitionId=1&branchName=develop)
|
||||
[](https://translate.servarr.com/engage/servarr/?utm_source=widget)
|
||||
[](https://wiki.servarr.com/radarr/installation/docker)
|
||||
|
||||
[](#backers)
|
||||
[](#sponsors)
|
||||
[](#mega-sponsors)
|
||||
All-in-one media manager for movies, books, and audiobooks.
|
||||
|
||||
Radarr is a movie collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new movies and will interface with clients and indexers to grab, sort, and rename them. It can also be configured to automatically upgrade the quality of existing files in the library when a better quality format becomes available.
|
||||
Note that only one type of a given movie is supported. If you want both a 4k version and 1080p version of a given movie you will need multiple instances.
|
||||
## Overview
|
||||
|
||||
## Major Features Include
|
||||
Logarr (from Greek λόγος - "word, reason") is a unified media management system forked from Radarr. It provides automated monitoring, downloading, and library management for multiple media types through a single interface.
|
||||
|
||||
* Adding new movies with lots of information, such as trailers, ratings, etc.
|
||||
* Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
|
||||
* Can watch for better quality of the movies you have and do an automatic upgrade. _eg. from DVD to Blu-Ray_
|
||||
* Automatic failed download handling will try another release if one fails
|
||||
* Manual search so you can pick any release or to see why a release was not downloaded automatically
|
||||
* Full integration with SABnzbd and NZBGet
|
||||
* Automatically searching for releases as well as RSS Sync
|
||||
* Automatically importing downloaded movies
|
||||
* Recognizing Special Editions, Director's Cut, etc.
|
||||
* Identifying releases with hardcoded subs
|
||||
* Identifying releases with AKA movie names
|
||||
* SABnzbd, NZBGet, QBittorrent, Deluge, rTorrent, Transmission, uTorrent, and other download clients are supported and integrated
|
||||
* Full integration with Kodi and Plex (notifications, library updates)
|
||||
* Importing Metadata such as trailers or subtitles
|
||||
* Adding metadata such as posters and information for Kodi and others to use
|
||||
* Advanced customization for profiles, such that Radarr will always download the copy you want
|
||||
* A beautiful UI
|
||||
**Current Status:** Early development. Movie functionality inherited from Radarr is working. Book and audiobook support is planned.
|
||||
|
||||
## Support
|
||||
## Features
|
||||
|
||||
[](https://wiki.servarr.com/radarr)
|
||||
[](https://radarr.video/discord)
|
||||
**Movies (working):**
|
||||
- Automated monitoring and quality upgrades
|
||||
- Metadata and artwork management
|
||||
- Integration with download clients and indexers
|
||||
|
||||
Note: GitHub Issues are for Bugs and Feature Requests Only
|
||||
**Books (planned):**
|
||||
- EPUB, MOBI, PDF quality tracking
|
||||
- Author and series hierarchy
|
||||
- Goodreads/Hardcover metadata
|
||||
|
||||
[](https://github.com/Radarr/Radarr/issues)
|
||||
**Audiobooks (planned):**
|
||||
- M4B, MP3, FLAC support
|
||||
- Narrator tracking and duration metadata
|
||||
- Audible metadata integration
|
||||
|
||||
## Contributors & Developers
|
||||
**General:**
|
||||
- Usenet and BitTorrent support
|
||||
- SABnzbd, NZBGet, qBittorrent, Deluge, rTorrent, Transmission integration
|
||||
- Plex and Kodi integration
|
||||
|
||||
[API Documentation](https://radarr.video/docs/api/)
|
||||
## Quick Start
|
||||
|
||||
This project exists thanks to all the people who contribute.
|
||||
- [Contribute (GitHub)](CONTRIBUTING.md)
|
||||
- [Contribution (Wiki Article)](https://wiki.servarr.com/radarr/contributing)
|
||||
```bash
|
||||
docker run -d \
|
||||
--name=logarr \
|
||||
-e PUID=1000 \
|
||||
-e PGID=1000 \
|
||||
-p 7878:7878 \
|
||||
-v /path/to/config:/config \
|
||||
-v /path/to/media:/media \
|
||||
--restart unless-stopped \
|
||||
ghcr.io/cody-k/logarr:latest
|
||||
```
|
||||
|
||||
[](https://github.com/Radarr/Radarr/graphs/contributors)
|
||||
Web interface: `http://localhost:7878`
|
||||
|
||||
## Backers
|
||||
## Building from Source
|
||||
|
||||
Thank you to all our backers! 🙏 [Become a backer](https://opencollective.com/Radarr#backer)
|
||||
Requirements: .NET 8.0 SDK, Node.js 20+, Yarn
|
||||
|
||||
[](https://opencollective.com/Radarr#backer)
|
||||
```bash
|
||||
git clone https://github.com/Cody-k/logarr.git
|
||||
cd logarr
|
||||
./build.sh --backend --frontend
|
||||
dotnet run --project src/Radarr
|
||||
```
|
||||
|
||||
## Sponsors
|
||||
## Roadmap
|
||||
|
||||
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor](https://opencollective.com/Radarr#sponsor)
|
||||
1. **Foundation** - Generalize database schema, implement hierarchical monitoring (Author → Series → Item)
|
||||
2. **Multi-Media** - Add book and audiobook quality profiles, port metadata providers
|
||||
3. **Interface** - Unified dashboard with type filters, type-specific detail views
|
||||
|
||||
[](https://opencollective.com/Radarr#sponsor)
|
||||
## Contributing
|
||||
|
||||
## Mega Sponsors
|
||||
Early development phase. Not currently accepting contributions while core architecture is established.
|
||||
|
||||
[](https://opencollective.com/Radarr#mega-sponsor)
|
||||
## License
|
||||
|
||||
## JetBrains
|
||||
[GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
|
||||
|
||||
Thank you to [<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.png" alt="JetBrains" width="96">](http://www.jetbrains.com/) for providing us with free licenses to their great tools.
|
||||
|
||||
* [<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/ReSharper_icon.png" alt="ReSharper" width="32"> ReSharper](http://www.jetbrains.com/resharper/)
|
||||
* [<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/WebStorm_icon.png" alt="WebStorm" width="32"> WebStorm](http://www.jetbrains.com/webstorm/)
|
||||
* [<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/Rider_icon.png" alt="Rider" width="32"> Rider](http://www.jetbrains.com/rider/)
|
||||
* [<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/dotTrace_icon.png" alt="dotTrace" width="32"> dotTrace](http://www.jetbrains.com/dottrace/)
|
||||
|
||||
## DigitalOcean
|
||||
|
||||
This project is also supported by DigitalOcean
|
||||
<p>
|
||||
<a href="https://www.digitalocean.com/">
|
||||
<img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="201px">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
### License
|
||||
|
||||
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
|
||||
* Copyright 2010-2025
|
||||
Logarr is a derivative of [Radarr](https://github.com/Radarr/Radarr). Copyright 2010-2025.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
Please report (suspected) security vulnerabilities on Discord (preferred) to
|
||||
any of the Servarr Dev role holders (red names) or via email: development@servarr.com. You will receive a response from
|
||||
us within 72 hours. If the issue is confirmed, we will release a patch as soon
|
||||
Please report (suspected) security vulnerabilities via GitHub issues at
|
||||
github.com/Cody-k/logarr/issues. You will receive a response
|
||||
within 72 hours. If the issue is confirmed, we will release a patch as soon
|
||||
as possible depending on complexity/severity.
|
||||
|
|
|
|||
Loading…
Reference in a new issue