Skip to content

Commit d42f968

Browse files
github-actions[bot]github-actions[bot]
committed
docs: snapshot 3.6.0
1 parent 15a3d72 commit d42f968

18 files changed

Lines changed: 3370 additions & 0 deletions

‎versioned_docs/version-3.6.0/API.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
id: api
3+
slug: /api
4+
description: Documentation of the Maintainerr API and its endpoints.
5+
title: API Docs
6+
hide:
7+
- navigation
8+
- toc
9+
status: recent
10+
---
11+
12+
13+
14+
:::danger
15+
:fire: :fire: The API, and all of Maintainerr for that matter, does not have an authentication method. There are certain API calls, that if you make your instance public facing, will expose your entire settings configuration. This could include all of your service's API keys. Proceed with extreme caution if you choose to expose Maintainerr to the public. :fire: :fire:
16+
17+
:::
18+
## API endpoints
19+
20+
:::info
21+
The current migration to Docusaurus has not implemented the swagger API documentation at this time. You can view the API documentation in app at `http://<maintainerr_url>/api/swagger`
22+
:::

‎versioned_docs/version-3.6.0/Changelog.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
id: changelog
3+
slug: /changelog
4+
title: Changelog
5+
description: Release history and upstream changelog references for Maintainerr.
6+
---
7+
8+
The Maintainerr changelog is maintained in the main application repository.
9+
10+
## Source of Truth
11+
12+
- [Maintainerr CHANGELOG.md](https://github.com/Maintainerr/Maintainerr/blob/main/CHANGELOG.md)
13+
- [Maintainerr Releases](https://github.com/Maintainerr/Maintainerr/releases)
14+
15+
## Notes
16+
17+
- The application repository is the authoritative source for release notes.
18+
- This docs page intentionally links to the upstream changelog instead of duplicating release content here.
19+
- When docs versioning is added, this page can later be upgraded to reference version-matched release notes or a generated OpenAPI/release artifact flow.

‎versioned_docs/version-3.6.0/Collections.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
id: collections
3+
slug: /collections
4+
description: Information about collection generation, media server syncing, and manual actions.
5+
title: Collections
6+
---
7+
8+
A collection is auto generated when defining a rule. A collection holds all media that either got picked up by the handling of the corresponding rule or got manually added.
9+
10+
When the specified amount of days that media must live in the collection is passed, the collection handler job will perform the necessary cleanup actions.
11+
12+
:::note Collection Handling
13+
Collection handling is a batch process that runs every 12 hours. You can manually trigger it with the `Handle collection` button on the Collections page.
14+
:::
15+
16+
## Media Server
17+
18+
A collection will be reflected in your media server when it contains media. When no media is present, there's no use of having it in your media server. The collection's title and description will be the same as the one in Maintainerr.
19+
20+
If the `Show on home` option was checked, the collection will be shown on all users' home screens. This allows you to create, for instance, a 'Leaving soon' list.
21+
22+
## Manual actions
23+
24+
### Adding
25+
26+
You can manually add media to a collection on the `Overview` page, by using the `Add` button on the media. Using the button will open a popup where you are able to pick the collection you wish to add the media to.
27+
28+
:::warning
29+
Please note that the first option selected is to **remove** media from all collections. However, if the media was added by the rule handler, it will be added again. If you wish to counter this behaviour, you must also exclude it from all collections.
30+
:::
31+
32+
### Removing
33+
34+
As mentioned in the section above, you are able to remove media from all collections using the `Add` popup on the `Overview` page by choosing the `Remove from all collections` option.
35+
36+
However, if you wish to just remove media from 1 collection it's easier to click on the collection's name on the `collections` page. This will show all media currently added to the collection. There you're able to remove specific media from the collection by using the `Remove` button.
37+
38+
:::note
39+
This will also exclude media from rule handling for this collection, so it won't be added again.
40+
:::
41+
42+
### Excluding
43+
44+
You're able to exclude media from all, or specific, collections by using the `Excl` button on the media's card from the `Overview` page. This will open a similar popup as adding media.
45+
46+
Here you're able to remove the media's current exclusions, exclude for all collections or exclude for a specific collection.
47+
48+
When media has exclusions, an `Excl` badge will be shown on the top-right side of the card.
49+
50+
### Data syncing from media server
51+
52+
If media is added to the collection outside of Maintainerr, it will be added to the associated Maintainerr collection. These manually added items will be ignored by the rule processor.
53+
54+
If you delete media from the collection outside of Maintainerr, it will be removed from the corresponding Maintainerr collection. However, if the media still matches your rules, it will be re-added to the collection in subsequent rule processing cycles.
55+
56+
## Misc
57+
58+
- By clicking on the collection's name you can see all media currently added to the collection. On the top-right side there'll be a number indicating the number of days before removal.
59+
60+
- Maintainerr will never remove the collection from your media server if you specified a manual collection.

‎versioned_docs/version-3.6.0/Common.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
id: common
3+
slug: /common
4+
description: Common problems, and their solutions.
5+
title: Common Problems
6+
---
7+
8+
9+
:::note
10+
These suggestions will not solve every issue, but they cover the most common problems people run into. If you try the steps below and still cannot get Maintainerr working as expected, reach out on [Discord](https://discord.maintainerr.info).
11+
:::
12+
13+
## Spinning Circle
14+
15+
**Problem:** I have installed Maintainerr, but when I open the page all I can see is a spinning circle.
16+
17+
This is usually a permissions problem. The container runs as user `1000` by default, and the host directory mounted to `/opt/data` often does not allow that user to read or write correctly.
18+
19+
:::tip Fix
20+
21+
- Check the logs with `docker logs -f maintainerr` and look for permission-related errors.
22+
- Update ownership on the mounted data directory: `sudo chown -R 1000:1000 <host-directory for /opt/data>`
23+
24+
:::
25+
26+
## Webpage is stuck
27+
28+
**Problem:** When I open the page for the first time, I can click on things but nothing happens.
29+
30+
When Maintainerr loads for the first time, it is supposed to redirect you to the initial media server settings page. Sometimes that redirect does not happen, which makes the page look stuck.
31+
32+
:::tip Fix
33+
Refresh the page.
34+
:::
35+
36+
## TVDBid or TMDBid errors
37+
38+
**Problem:** My logs contain warnings about missing `TVDBid` or `TMDBid`, such as:
39+
40+
`[maintainerr] | 01/10/2024 14:20:52 [WARN] [SonarrGetterService] [TVDB] Failed to fetch tvdb id for 'Some TV Show'`
41+
42+
This is usually caused by bad or incomplete metadata on the affected item in your media server. Maintainerr relies on that metadata to match the exact same movie or show in Sonarr, Radarr, Overseerr, Jellyseerr, or Tautulli.
43+
44+
:::tip Fix
45+
There is not a reliable fix yet. The issue usually originates from your media server metadata and the IDs it assigns, or fails to assign, to the item.
46+
47+
If your media server has a metadata refresh or rematch option for the affected item, you can try that, but it is not guaranteed to resolve the problem.
48+
:::
49+
50+
## Deleting Items
51+
52+
**Problem:** I set `Take action after days` to `0`, but nothing is being removed.
53+
54+
`0` is supported, but actions are still processed by the `Collection Handler` scheduled task. That means the item will not be handled immediately when you save the rule.
55+
56+
:::tip Fix
57+
If `Take action after days` is set to `0`, the action will run when one of these happens:
58+
59+
- You manually click `Handle Collections`
60+
- The next `Collection Handler` task runs on its normal schedule
61+
62+
So `0` means "no waiting period before eligibility," not "take action instantly at save time."
63+
:::
64+
65+
## Pre-made Rules
66+
67+
**Problem:** Is there a set of pre-made rules I can use as a starting point?
68+
69+
Yes. When creating a new rule, use the `Community` button to browse rules uploaded by other users. There is a voting system to help surface popular or useful entries, but community rules are not reviewed or guaranteed to work as advertised.
70+
71+
:::tip Location
72+
![Community Button](/img/community_button.png)
73+
:::
74+
75+
## Status of Services
76+
77+
**Problem:** Community Rules will not load, or the Feature Requests page is unavailable.
78+
79+
Some Maintainerr services are self-hosted and others are hosted externally. Downtime can happen even though we try to keep it minimal.
80+
81+
:::tip Check Status
82+
You can check the current service status at [status.maintainerr.info](https://status.maintainerr.info).
83+
:::

‎versioned_docs/version-3.6.0/Configuration.md‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
id: configuration
3+
slug: /configuration
4+
description: Information on how to get Maintainerr up and running.
5+
title: Configuration
6+
---
7+
8+
9+
All configuration is done inside the application. No extra config files are required.
10+
11+
When you first access the web UI, you should be redirected to the settings page. If that does not happen, try refreshing the page.
12+
13+
:::note
14+
All Base URL settings are to be entered without the leading slash.
15+
16+
- Right: `tautulli`
17+
- Wrong: `/tautulli`
18+
19+
:::
20+
21+
## General
22+
23+
These settings are OK for most installations.
24+
25+
| Setting | Description |
26+
| --- | --- |
27+
| Hostname | The hostname or IP address of the host running Maintainerr |
28+
| API key | Maintainerr's API key. It is currently reserved for future use. |
29+
30+
## Media Server
31+
32+
You need to configure either Plex or Jellyfin. Both are not supported simultaneously.
33+
34+
## Plex
35+
36+
Plex can be used as your media server connection.
37+
38+
When using a local Plex instance, make sure Plex's `Secure connections` network setting is set to `Preferred` instead of `Required`.
39+
40+
If you want Maintainerr to connect securely, use your `*.plex.direct` URL as the hostname and include `https://`. You can usually copy this from Seerr if that service is already connected to the same Plex server.
41+
42+
| Setting | Description |
43+
| --- | --- |
44+
| Name | A friendly name for this server |
45+
| Hostname or IP | The domain name or local IP address of the host running Plex |
46+
| Port | The port Plex runs on. Default: `32400` |
47+
| Authentication | Authenticate with your Plex server using an **admin** account |
48+
49+
:::tip
50+
Typical setup flow: authenticate with Plex, click the refresh icon, choose your server from the dropdown, click `Save Changes`, then click `Test Saved`.
51+
:::
52+
53+
## Jellyfin
54+
55+
Jellyfin can also be used as your media server connection.
56+
57+
| Setting | Description |
58+
| --- | --- |
59+
| Jellyfin URL | The domain name or local IP address of the host running Jellyfin |
60+
| API key | A Jellyfin API key generated from your Jellyfin server |
61+
| Admin User | Test Connection to load the available admin users |
62+
63+
## Seerr
64+
65+
Seerr configuration is required if you want to use Seerr-related rule parameters or remove Seerr requests.
66+
67+
| Setting | Description |
68+
| --- | --- |
69+
| URL | The domain name or local IP address of the host running Seerr |
70+
| API key | The API key from Seerr settings |
71+
72+
## Radarr
73+
74+
Radarr's configuration is required to use its parameters in rules and to remove or unmonitor movies.
75+
76+
| Setting | Description |
77+
| --- | --- |
78+
| Server Name | A friendly name to help identify the server |
79+
| Hostname or IP | The domain name or local IP address of the host running Radarr |
80+
| Port | The port Radarr runs on |
81+
| Base URL | The URL base configured in Radarr, if one is set |
82+
| API key | The API key from Radarr settings |
83+
84+
## Sonarr
85+
86+
Sonarr's configuration is required to use its parameters in rules and to remove or unmonitor shows.
87+
88+
| Setting | Description |
89+
| --- | --- |
90+
| Server Name | A friendly name to help identify the server |
91+
| Hostname or IP | The domain name or local IP address of the host running Sonarr |
92+
| Port | The port Sonarr runs on |
93+
| Base URL | The URL base configured in Sonarr, if one is set |
94+
| API key | The API key from Sonarr settings |
95+
96+
## Tautulli
97+
98+
:::note
99+
Tautulli is only available for Plex users
100+
:::
101+
102+
Tautulli's configuration is required to use its parameters in rules.
103+
104+
| Setting | Description |
105+
| --- | --- |
106+
| URL| The domain name or local IP address of the host running Tautulli |
107+
| API key | The API key from Tautulli settings |

‎versioned_docs/version-3.6.0/Contributing.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
id: contributing
3+
slug: /contributing
4+
description: Contributing to Maintainerr in some way? Look no further. All you need to get started is here in this page.
5+
title: Contributing
6+
---
7+
8+
Thanks for helping improve the Maintainerr documentation.
9+
10+
Guides, walkthroughs, corrections, screenshots, wording improvements, and structural cleanup are all useful contributions.
11+
12+
### Local Development
13+
14+
Install dependencies:
15+
16+
```bash
17+
npm install
18+
```
19+
20+
Start the local development server:
21+
22+
```bash
23+
npm start
24+
```
25+
26+
Create a production build:
27+
28+
```bash
29+
npm run build
30+
```
31+
32+
Serve the production build locally:
33+
34+
```bash
35+
npm run serve
36+
```
37+
38+
### Project Structure
39+
40+
- `docs/` contains the main documentation pages
41+
- `blog/` contains walkthroughs and blog posts
42+
- `static/` contains static assets such as images and other files served directly
43+
- `src/` contains site-level styling and React-based customizations
44+
- `docusaurus.config.js` contains the site configuration
45+
- `sidebars.js` contains the docs navigation structure
46+
47+
## Docs Contribution Guidelines
48+
49+
- Keep pull requests focused and easy to review
50+
- Prefer native Markdown and Docusaurus syntax over raw HTML when possible
51+
- Use `media server` unless a page is describing Plex-specific or Jellyfin-specific behavior
52+
- Use `Seerr` instead of older separate Overseerr or Jellyseerr terminology
53+
- Verify screenshots, labels, and workflow wording against the current app behavior before merging
54+
- Run `npm run build` before opening a pull request when you make structural or formatting changes
55+
56+
If you are making a larger docs change, it is usually better to split content cleanup, structural changes, and visual changes into separate pull requests.
57+
58+
## App Contributions
59+
60+
If you want to contribute to the Maintainerr application itself, use the upstream app repository guide:
61+
62+
- [Maintainerr App Contributing Guide](https://github.com/maintainerr/maintainerr/blob/main/CONTRIBUTING.md)
63+
64+
That guide covers:
65+
66+
- development environment setup
67+
- branch and pull request expectations
68+
- Conventional Commits
69+
- code formatting and review expectations
70+
- UI text guidelines
71+
- AI-assisted contribution expectations
72+
73+
## Need Help?
74+
75+
If you are unsure where to start, open an issue or ask in the community:
76+
77+
- [Maintainerr Discord](https://discord.maintainerr.info)
78+
- [Docs Repository Issues](https://github.com/maintainerr/Maintainerr_docs/issues)

0 commit comments

Comments
 (0)