From da88771da58cde7703b2c634da609c752135b336 Mon Sep 17 00:00:00 2001 From: notfakie <103784113+notfakie@users.noreply.github.com> Date: Sat, 16 Apr 2022 11:31:35 +1200 Subject: [PATCH] update README & repo links throughout repo. Fixes outdated message displayed in app --- .github/ISSUE_TEMPLATE/bug.yml | 2 +- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/enhancement.yml | 2 +- CONTRIBUTING.md | 8 +- README.md | 156 +++--------------- docs/README.md | 2 +- docs/support/faq.md | 6 +- docs/support/need-help.md | 2 +- .../using-overseerr/notifications/pushover.md | 2 +- package.json | 2 +- server/api/github.ts | 4 +- .../Settings/SettingsAbout/Releases/index.tsx | 2 +- .../Settings/SettingsAbout/index.tsx | 14 +- 13 files changed, 43 insertions(+), 161 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 39a838a98..9bfffb24b 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -85,7 +85,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/sct/overseerr/blob/develop/CODE_OF_CONDUCT.md) + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/fallenbagel/jellyseerr/blob/develop/CODE_OF_CONDUCT.md) options: - label: I agree to follow Overseerr's Code of Conduct required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 060169454..13a684958 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -4,5 +4,5 @@ contact_links: url: https://discord.gg/ckbvBtDJgC about: Chat with other users and the Overseerr dev team - name: πŸ’¬ Support via GitHub Discussions - url: https://github.com/sct/overseerr/discussions + url: https://github.com/fallenbagel/jellyseerr/discussions about: Ask questions and discuss with other community members diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml index 0cf7faab4..aee473591 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -31,7 +31,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/sct/overseerr/blob/develop/CODE_OF_CONDUCT.md) + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/fallenbagel/jellyseerr/blob/develop/CODE_OF_CONDUCT.md) options: - label: I agree to follow Overseerr's Code of Conduct required: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 35c1f21c6..a016f6d46 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,7 @@ All help is welcome and greatly appreciated! If you would like to contribute to 2. Add the remote `upstream`: ```bash - git remote add upstream https://github.com/sct/overseerr.git + git remote add upstream https://github.com/fallenbagel/jellyseerr.git ``` 3. Create a new branch: @@ -66,7 +66,7 @@ All help is welcome and greatly appreciated! If you would like to contribute to ### Contributing Code -- If you are taking on an existing bug or feature ticket, please comment on the [issue](https://github.com/sct/overseerr/issues) to avoid multiple people working on the same thing. +- If you are taking on an existing bug or feature ticket, please comment on the [issue](https://github.com/fallenbagel/jellyseerr/issues) to avoid multiple people working on the same thing. - All commits **must** follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) - Pull requests with commits not following this standard will **not** be merged. - Please make meaningful commits, or squash them prior to opening a pull request. @@ -76,7 +76,7 @@ All help is welcome and greatly appreciated! If you would like to contribute to - You can create a "draft" pull request early to get feedback on your work. - Your code **must** be formatted correctly, or the tests will fail. - We use Prettier to format our code base. It should automatically run with a Git hook, but it is recommended to have the Prettier extension installed in your editor and format on save. -- If you have questions or need help, you can reach out via [Discussions](https://github.com/sct/overseerr/discussions) or our [Discord server](https://discord.gg/ckbvBtDJgC). +- If you have questions or need help, you can reach out via [Discussions](https://github.com/fallenbagel/jellyseerr/discussions) or our [Discord server](https://discord.gg/ckbvBtDJgC). - Only open pull requests to `develop`, never `master`! Any pull requests opened to `master` will be closed. ### UI Text Style @@ -97,7 +97,7 @@ When adding new UI text, please try to adhere to the following guidelines: ## Translation -We use [Weblate](https://hosted.weblate.org/engage/overseerr/) for our translations, and your help with localizing Overseerr would be greatly appreciated! If your language is not listed below, please [open a feature request](https://github.com/sct/overseerr/issues/new/choose). +We use [Weblate](https://hosted.weblate.org/engage/overseerr/) for our translations, and your help with localizing Overseerr would be greatly appreciated! If your language is not listed below, please [open a feature request](https://github.com/fallenbagel/jellyseerr/issues/new/choose). Translation status diff --git a/README.md b/README.md index f1604d750..3751765da 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,22 @@

-Overseerr +Jellyseerr

-Overseerr Release -Overseerr CI -

-

-Discord +Discord Docker pulls -Translation status -Language grade: JavaScript -GitHub - -All Contributors - +GitHub

-**Overseerr** is a free and open source software application for managing requests for your media library. It integrates with your existing services, such as **[Sonarr](https://sonarr.tv/)**, **[Radarr](https://radarr.video/)**, and **[Plex](https://www.plex.tv/)**! +**Jellyseerr** is a free and open source software application for managing requests for your media library. It is a a fork of Overseerr built to bring support for Jellyfin & Emby media servers! ## Current Features +- Jellyfin Support +- Emby Support + +Along with all the existing Overseerr features: - Full Plex integration. Authenticate and manage user access with Plex! -- Easy integration with your existing services. Currently, Overseerr supports Sonarr and Radarr. More to come! +- Easy integration with your existing services. Currently, Jellyseerr supports Sonarr and Radarr. More to come! - Plex library scan, to keep track of the titles which are already available. - Customizable request system, which allows users to request individual seasons or movies in a friendly, easy-to-use interface. - Incredibly simple request management UI. Don't dig through the app to simply approve recent requests! @@ -29,13 +24,12 @@ - Support for various notification agents. - Mobile-friendly design, for when you need to approve requests on the go! -With more features on the way! Check out our [issue tracker](https://github.com/sct/overseerr/issues) to see the features which have already been requested. +With more features on the way! Check out our [issue tracker](https://github.com/fallenbagel/jellyseerr/issues) to see the features which have already been requested. ## Getting Started -Check out our documentation for instructions on how to install and run Overseerr: - -https://docs.overseerr.dev/getting-started/installation +Check out our dockerhub for instructions on how to install and run Jellyseerr: +https://hub.docker.com/r/fallenbagel/jellyseerr ## Preview @@ -43,134 +37,22 @@ https://docs.overseerr.dev/getting-started/installation ## Support -- Check out the [Overseerr Documentation](https://docs.overseerr.dev/) before asking for help. Your question might already be in the [FAQ](https://docs.overseerr.dev/support/faq). - You can get support on [Discord](https://discord.gg/ckbvBtDJgC). -- You can ask questions in the Help category of our [GitHub Discussions](https://github.com/sct/overseerr/discussions). -- Bug reports and feature requests can be submitted via [GitHub Issues](https://github.com/sct/overseerr/issues). +- You can ask questions in the Help category of our [GitHub Discussions](https://github.com/fallenbagel/jellyseerr/discussions). +- Bug reports and feature requests can be submitted via [GitHub Issues](https://github.com/fallenbagel/jellyseerr/issues). ## API Documentation -Our documentation is built on every commit and hosted at https://api-docs.overseerr.dev - -You can also access the API documentation from your local Overseerr install at http://localhost:5055/api-docs +You can access the API documentation from your local Jellyseerr install at http://localhost:5055/api-docs ## Community -You can ask questions, share ideas, and more in [GitHub Discussions](https://github.com/sct/overseerr/discussions). +You can ask questions, share ideas, and more in [GitHub Discussions](https://github.com/fallenbagel/jellyseerr/discussions). -If you would like to chat with other members of our growing community, [join the Overseerr Discord server](https://discord.gg/ckbvBtDJgC)! +If you would like to chat with other members of our growing community, [join the Jellyseerr Discord server](https://discord.gg/ckbvBtDJgC)! -Our [Code of Conduct](https://github.com/sct/overseerr/blob/develop/CODE_OF_CONDUCT.md) applies to all Overseerr community channels. +Our [Code of Conduct](https://github.com/fallenbagel/jellyseerr/blob/develop/CODE_OF_CONDUCT.md) applies to all Jellyseerr community channels. ## Contributing -You can help improve Overseerr too! Check out our [Contribution Guide](https://github.com/sct/overseerr/blob/develop/CONTRIBUTING.md) to get started. - -## Contributors ✨ - -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

sct
πŸ’» 🎨 πŸ€”
Alex Zoitos
πŸ’»
Brandon Cohen
πŸ’» πŸ“–
Ahreluth
🌍
KovalevArtem
🌍
GiyomuWeb
🌍
Angry Cuban
πŸ“–

jvennik
🌍
darknessgp
πŸ’»
salty
πŸš‡
Shutruk
🌍
Krystian Charubin
🎨
Kieron Boswell
πŸ’»
samwiseg0
πŸ’¬ πŸš‡

ecelebi29
πŸ’» πŸ“–
MārtiΕ†Ε‘ MoΕΎeiko
πŸ’»
mazzetta86
🌍
Paul Hagedorn
🌍
Shagon94
🌍
sebstrgg
🌍
Danshil Mungur
πŸ’» πŸ“–

doob187
πŸš‡
johnpyp
πŸ’»
Jakob Ankarhem
πŸ“– πŸ’» 🌍
Jayesh
πŸ’»
flying-sausages
πŸ“–
hirenshah
πŸ“–
TheCatLady
πŸ’» 🌍 πŸ“–

Chris Pritchard
πŸ’» πŸ“–
Tamberlox
🌍
David
πŸ’»
Douglas Parker
πŸ“–
Daniel Carter
πŸ’»
nuro
πŸ“–
α—ͺΡ”Ξ½ΞΉΞ· α—·Ο…Π½ΚŸ
πŸš‡

JonnyWong16
πŸ“–
Roxedus
πŸ“–
WoisWoi
🌍
HubDuck
🌍 πŸ“–
costaht
πŸ“– 🌍
Shjosan
🌍
kobaubarr
🌍

Ricardo GonzΓ‘lez
🌍
Torkil
🌍
Jagandeep Brar
πŸ“–
dtalens
🌍
Alex Cortelyou
πŸ’»
Jono Cairns
πŸ’»
DJScias
🌍

Dabu-dot
🌍
Jabster28
πŸ’»
littlerooster
🌍
Dustin Hildebrandt
πŸ’»
Bruno Guerreiro
🌍
Alexander NeuhΓ€user
🌍
Livio
🎨

tangentThought
πŸ’»
NicolΓ‘s Espinoza
πŸ’»
sootylunatic
🌍
JoKerIsCraZy
🌍
Daddie0
🌍
Simone
🌍
Seohyun Joo
🌍

Sergey
🌍
Shaaft
🌍
sr093906
🌍
Nackophilz
🌍
Sean Chambers
πŸ’»
deniscerri
🌍
tomgacz
🌍

Andersborrits
🌍
Maxent
🌍
- - - - - +You can help improve Jellyseerr too! Check out our [Contribution Guide](https://github.com/fallenbagel/jellyseerr/blob/develop/CONTRIBUTING.md) to get started. \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index a55645308..4a2c846a4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -21,4 +21,4 @@ The primary motivation for starting this project was to have an incredibly perfo Overseerr is an ambitious project. We have already poured a lot of work into this, and have a lot more to do. We need your valuable feedback and help to find and fix bugs. Also, with Overseerr being an open-source project, anyone is welcome to contribute. Contribution includes building new features, patching bugs, translating the application, or even just writing documentation. -If you would like to contribute, please be sure to review our [contribution guidelines](https://github.com/sct/overseerr/blob/develop/CONTRIBUTING.md). +If you would like to contribute, please be sure to review our [contribution guidelines](https://github.com/fallenbagel/jellyseerr/blob/develop/CONTRIBUTING.md). diff --git a/docs/support/faq.md b/docs/support/faq.md index e13ccd544..56a170941 100644 --- a/docs/support/faq.md +++ b/docs/support/faq.md @@ -34,7 +34,7 @@ You sure can! We are using [Weblate](https://hosted.weblate.org/engage/overseerr You can find the changelog for your version (stable/`latest`,s or `develop`) in the **Settings → About** page in your Overseerr instance. -You can alternatively review the [stable release history](https://github.com/sct/overseerr/releases) and [`develop` branch commit history](https://github.com/sct/overseerr/commits/develop) on GitHub. +You can alternatively review the [stable release history](https://github.com/fallenbagel/jellyseerr/releases) and [`develop` branch commit history](https://github.com/fallenbagel/jellyseerr/commits/develop) on GitHub. ### Some media is missing from Overseerr that I know is in Plex! @@ -88,7 +88,7 @@ Yes! Please see the [documentation for creating local users](../using-overseerr/ ### Is is possible to set user roles in Overseerr? -Permissions can be configured for each user via the **User List** or their **User Settings** page. The list of assignable permissions is still growing, so if you have any suggestions, [submit a feature request](https://github.com/sct/overseerr/issues/new/choose)! +Permissions can be configured for each user via the **User List** or their **User Settings** page. The list of assignable permissions is still growing, so if you have any suggestions, [submit a feature request](https://github.com/fallenbagel/jellyseerr/issues/new/choose)! ## Requests @@ -118,7 +118,7 @@ If you configured a URL base in Sonarr, make sure you have also configured the [ Also, check that you are using Sonarr v3 and that you have configured a default language profile in Overseerr. -Language profile support for Sonarr was added in [v1.20.0](https://github.com/sct/overseerr/releases/tag/v1.20.0) along with a new, _required_ **Language Profile** setting. If series requests are failing, make sure that you have a default language profile configured for each of your Sonarr servers in **Settings → Services**. +Language profile support for Sonarr was added in [v1.20.0](https://github.com/fallenbagel/jellyseerr/releases/tag/v1.20.0) along with a new, _required_ **Language Profile** setting. If series requests are failing, make sure that you have a default language profile configured for each of your Sonarr servers in **Settings → Services**. ## Notifications diff --git a/docs/support/need-help.md b/docs/support/need-help.md index 4d31f5d50..a2f77e677 100644 --- a/docs/support/need-help.md +++ b/docs/support/need-help.md @@ -9,7 +9,7 @@ Before seeking assistance, please make sure you have first tried these following - **Analyzing** your logs, you just might find the solution yourself! - **Searching** the [documentation](../README.md), [installation guide](../getting-started/installation.md), and [FAQs](./faq.md). -If you still have questions after troubleshooting on your own, feel free to ask on [Discord](https://discord.gg/ckbvBtDJgC)! (Please review our [Code of Conduct](https://github.com/sct/overseerr/blob/develop/CODE_OF_CONDUCT.md) before posting.) +If you still have questions after troubleshooting on your own, feel free to ask on [Discord](https://discord.gg/ckbvBtDJgC)! (Please review our [Code of Conduct](https://github.com/fallenbagel/jellyseerr/blob/develop/CODE_OF_CONDUCT.md) before posting.) Be sure to also include a link to your logs. (Please see [How can I share my logs?](#how-can-i-share-my-logs) below.) diff --git a/docs/using-overseerr/notifications/pushover.md b/docs/using-overseerr/notifications/pushover.md index cc09bfb69..9554dc453 100644 --- a/docs/using-overseerr/notifications/pushover.md +++ b/docs/using-overseerr/notifications/pushover.md @@ -10,7 +10,7 @@ User notifications are separate from system notifications, and the available not ### Application/API Token -[Register an application](https://pushover.net/apps/build) and enter the API token in this field. (You can use one of the [official icons in our GitHub repository](https://github.com/sct/overseerr/tree/develop/public) when configuring the application.) +[Register an application](https://pushover.net/apps/build) and enter the API token in this field. (You can use one of the [official icons in our GitHub repository](https://github.com/fallenbagel/jellyseerr/tree/develop/public) when configuring the application.) For more details on registering applications or the API token, please see the [Pushover API documentation](https://pushover.net/api#registration). diff --git a/package.json b/package.json index 7e885c776..11af08410 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,7 @@ }, "repository": { "type": "git", - "url": "https://github.com/sct/overseerr.git" + "url": "https://github.com/fallenbagel/jellyseerr.git" }, "license": "MIT", "dependencies": { diff --git a/server/api/github.ts b/server/api/github.ts index 48b8854b1..a2a71b41f 100644 --- a/server/api/github.ts +++ b/server/api/github.ts @@ -83,7 +83,7 @@ class GithubAPI extends ExternalAPI { } = {}): Promise { try { const data = await this.get( - '/repos/sct/overseerr/releases', + '/repos/fallenbagel/jellyseerr/releases', { params: { per_page: take, @@ -110,7 +110,7 @@ class GithubAPI extends ExternalAPI { } = {}): Promise { try { const data = await this.get( - '/repos/sct/overseerr/commits', + '/repos/fallenbagel/jellyseerr/commits', { params: { per_page: take, diff --git a/src/components/Settings/SettingsAbout/Releases/index.tsx b/src/components/Settings/SettingsAbout/Releases/index.tsx index 81db42e54..9b025e00e 100644 --- a/src/components/Settings/SettingsAbout/Releases/index.tsx +++ b/src/components/Settings/SettingsAbout/Releases/index.tsx @@ -21,7 +21,7 @@ const messages = defineMessages({ }); const REPO_RELEASE_API = - 'https://api.github.com/repos/sct/overseerr/releases?per_page=20'; + 'https://api.github.com/repos/fallenbagel/jellyseerr/releases?per_page=20'; interface GitHubRelease { url: string; diff --git a/src/components/Settings/SettingsAbout/index.tsx b/src/components/Settings/SettingsAbout/index.tsx index edaffd795..ab79b11cd 100644 --- a/src/components/Settings/SettingsAbout/index.tsx +++ b/src/components/Settings/SettingsAbout/index.tsx @@ -72,7 +72,7 @@ const SettingsAbout: React.FC = () => {

{ { { - https://github.com/sct/overseerr/discussions + https://github.com/fallenbagel/jellyseerr/discussions