Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add overseerr docs #48

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
{
"cSpell.words": [
"Namecheap",
"Organizr",
"Xenial",
"Xmrig",
"adduser",
"appdata",
"ansiutf",
"appdata",
"autodl",
"bazarr",
"blackhole",
Expand All @@ -19,8 +21,9 @@
"duckdns",
"emby",
"ffmpeg",
"htop",
"filebrowser",
"foss",
"htop",
"htpasswd",
"httprpc",
"irssi",
Expand All @@ -30,6 +33,7 @@
"letsencrypt",
"liara",
"libboost",
"librespeed",
"libtorrent",
"lidarr",
"netdata",
Expand All @@ -39,12 +43,14 @@
"nzbhydra",
"nzbs",
"ombi",
"overseerr",
"pacman",
"pastebin",
"plex",
"plexmediaserver",
"plexupdate",
"pyload",
"qbittorrent",
"qrencode",
"quassel",
"radarr",
Expand Down
53 changes: 53 additions & 0 deletions docs/applications/overseerr.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
id: overseerr
title: Overseerr
sidebar_label: Overseerr
---

overseerr is a self-hosted web application that automatically gives your shared Plex or Emby users the ability to request content by themselves! overseerr can be linked to multiple TV Show and Movie DVR tools to create a seamless end-to-end experience for your users.

## Initial Setup

Installing overseerr is easy. Simply issue the following command from SSH:

```bash main
sudo box install overseerr
```

This command will configure and install overseerr for your user.

After installation, the files are stored in `/opt/overseerr`

## Upgrading

You can upgrade Overseerr by running the following command

```bash
sudo box upgrade overseerr
```

## How to Access

After installation, overseerr will be available at the following web address: `https://<hostname.ltd>/overseerr`.

In case you're not using nginx, you will find overseerr

## Service Management

The service file resides at:

```bash
/etc/systemd/system/overseerr.service
```

import SystemdTabs from '../snippets/systemdtabs.mdx';

<SystemdTabs service="overseerr"/>

## Troubleshooting

import Troubleshooting from '../snippets/troubleshooting.md';

<Troubleshooting />

Please refer to Overseerr's github project, the docs and Discord for any application-sepcific issues.
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ module.exports = {
"applications/lidarr",
"applications/medusa",
"applications/ombi",
"applications/overseerr",
"applications/sickchill",
"applications/sickgear",
"applications/sonarr",
Expand Down
4 changes: 4 additions & 0 deletions src/theme/Applications/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,10 @@ const data = [
title: "Organizr",
url: "applications/organizr",
},
{
title: "Overseerr",
url: "applications/overseerr",
},
{
title: "Plex",
url: "applications/plex",
Expand Down