Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
b7e8a06
testing dev branch
ydkmlt84 Oct 3, 2024
fd5a6de
adding API page
ydkmlt84 Oct 6, 2024
9f34d76
added critic markdown
ydkmlt84 Oct 6, 2024
cd03330
icons
ydkmlt84 Oct 6, 2024
7ee2fa2
testing1
ydkmlt84 Oct 6, 2024
20dc974
test2
ydkmlt84 Oct 6, 2024
666bcd7
testing empty button
ydkmlt84 Oct 6, 2024
056e707
test3
ydkmlt84 Oct 6, 2024
50e32da
testing action for dev branch
ydkmlt84 Oct 6, 2024
fac5626
testing action again
ydkmlt84 Oct 6, 2024
a736cee
adding action to dev branch
ydkmlt84 Oct 6, 2024
34596e3
versioning
ydkmlt84 Oct 10, 2024
ee25506
tautulli and dev clarification
ydkmlt84 Oct 10, 2024
fc1baba
run and compose instructions
ydkmlt84 Oct 10, 2024
3de2ddc
drop down menus
ydkmlt84 Oct 10, 2024
7583dfc
dropdown syntax
ydkmlt84 Oct 10, 2024
899b828
making new status icon
ydkmlt84 Oct 10, 2024
cb9bfa3
added last updated to bottom
ydkmlt84 Oct 10, 2024
4eea2fd
dev icons
ydkmlt84 Oct 10, 2024
96862c5
still working on dev icon
ydkmlt84 Oct 10, 2024
b5b4e7c
dev icon css changes
ydkmlt84 Oct 10, 2024
201b985
still workinng on icons
ydkmlt84 Oct 10, 2024
ec628b7
testing happy status
ydkmlt84 Oct 10, 2024
e3a9a0b
happy icon
ydkmlt84 Oct 10, 2024
42295d8
recently updated icon
ydkmlt84 Oct 10, 2024
03d77d7
plus icon
ydkmlt84 Oct 10, 2024
d94618f
Update extra.css
ydkmlt84 Oct 10, 2024
f8e5060
removed api for now
ydkmlt84 Oct 10, 2024
a70fe80
update workflow to test for branch
ydkmlt84 Oct 10, 2024
932d29a
workflow
ydkmlt84 Oct 10, 2024
b585c02
workflow2
ydkmlt84 Oct 10, 2024
e35969a
workflow3
ydkmlt84 Oct 10, 2024
aaf7f94
workflow 4
ydkmlt84 Oct 10, 2024
7520376
workflow 5
ydkmlt84 Oct 10, 2024
d55164a
workflow 6
ydkmlt84 Oct 10, 2024
b5f52ac
workflow 7
ydkmlt84 Oct 10, 2024
f05fa2a
workflow 8
ydkmlt84 Oct 10, 2024
888ef70
workflow 15
ydkmlt84 Oct 10, 2024
ab22d3c
workflow 47
ydkmlt84 Oct 10, 2024
2d83d00
workflow 82
ydkmlt84 Oct 11, 2024
176726e
discord notification only for main branch
ydkmlt84 Oct 11, 2024
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
21 changes: 15 additions & 6 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- 'main'
- 'develop'
release:
type: [published]
pull_request:
Expand All @@ -18,9 +19,8 @@ on:
description: Turn this on to skip running the SSH script.
default: false

jobs:
jobs:
execute-command:
if: ${{ github.triggering_actor == github.repository_owner }}
name: Use tailscale to connect and execute command.
runs-on: ubuntu-24.04
steps:
Expand All @@ -34,7 +34,7 @@ jobs:
run: echo ${{inputs.dry-run}}
shell: bash
- name: executing remote ssh commands using password
if: ${{ inputs.dry-run == false }}
if: ${{ inputs.dry-run == false && github.ref_name == 'main'}}
uses: appleboy/ssh-action@v1.0.3
with:
host: ${{ secrets.SSH_HOST_TS }}
Expand All @@ -43,11 +43,20 @@ jobs:
port: ${{ secrets.SSH_PORT }}
script_stop: true
script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute.sh
- name: Dev- executing remote ssh commands using password
if: ${{ inputs.dry-run == false && github.ref_name == 'develop'}}
uses: appleboy/ssh-action@v1.0.3
with:
host: ${{ secrets.SSH_HOST_TS }}
username: ${{ secrets.SSH_USERNAME }}
password: ${{ secrets.SSH_PASSWORD }}
port: ${{ secrets.SSH_PORT }}
script_stop: true
script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh
- name: Actions for Discord
if: ${{ github.ref_name == 'main'}}
uses: Ilshidur/action-discord@0.3.2
env:
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
with:
args: 'The docs have been updated. Take a look. https://docs.maintainerr.info'


args: 'The docs have been updated. Take a look. https://docs.maintainerr.info'
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.cache
action_execute.sh
ascii.txt
action_execute_dev.sh
3 changes: 3 additions & 0 deletions docs/Collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,6 @@ When media has exclusions, an `Excl` badge will be shown on the top-right side o
- Maintainerr will never remove the collection from Plex if you specified a manual collection.

- You could add media directly to the Plex collection within Plex. Maintainerr will sync Media with the Plex collection. (The Plex collection might not always be available in case you're using an automatic collection)

:material-clock-edit: Last Updated: 10/10/24

8 changes: 6 additions & 2 deletions docs/Common.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@

---
status: new
---
> !!! info
These are not going to solve *every* problem and the suggested solutions might not correct your problem. If you have tried what is laid out here and it still isn't working as expected. Please reach out on [Discord](https://discord.gg/WP4ZW2QYwk).

Expand Down Expand Up @@ -55,4 +57,6 @@ Q. When I try to load the Community Rules I get a spinning circle and they never
A. Some of these services are self-hosted and some are hosted elsewhere. There are downtimes, but we try to minimize them as much as possible.

??? example "See The Fix?"
There is a website where you can see the status of our services. https://status.maintainerr.info
There is a website where you can see the status of our services. https://status.maintainerr.info

:material-clock-edit: Last Updated: 10/10/24
6 changes: 4 additions & 2 deletions docs/Configuration.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


All configuration is done inside the application, no extra config is required in files. </br>
At first boot you will be redirected to the settings page.

Expand Down Expand Up @@ -54,7 +56,7 @@ Sonarr's configuration is required to use it's parameters in rules and to remove
| Port | The port Sonarr runs on |
| Api key | Sonarr API key, should be visible in the Sonarr settings |

## Tautulli
## Tautulli :test_tube:{ .dev title="In dev branch only"}

Tautulli's configuration is required to use it's parameters in rules.

Expand All @@ -64,4 +66,4 @@ Tautulli's configuration is required to use it's parameters in rules.
| Port | The port Tautulli runs on |
| Api key | Tautulli API key, should be visible in the Tautulli settings |

:material-clock-edit: Last Updated: 9/30/24
:material-clock-edit: Last Updated: 10/10/24
3 changes: 3 additions & 0 deletions docs/Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,3 +120,6 @@ When adding new UI text, please try to adhere to the following guidelines:
## Attribution

This contribution guide was inspired by the [Overseerr](https://github.com/sct/overseerr) contribution guide.

:material-clock-edit: Last Updated: 10/10/24

6 changes: 4 additions & 2 deletions docs/Glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,7 @@ The key is used for identification in Yaml rule files.
- Availability: movies, shows, seasons, episodes
- Type: boolean

### Tautulli
### Tautulli :test_tube:{ .dev title="In dev branch only"}

#### Viewed by (username)

Expand All @@ -526,4 +526,6 @@ The key is used for identification in Yaml rule files.

- Key: Tautulli.sw_allEpisodesSeenBy
- Availability: shows, seasons
- Type: text[]
- Type: text[]

:material-clock-edit: Last Updated: 10/10/24
18 changes: 15 additions & 3 deletions docs/Installation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
status: recent
---

Docker is Maintainerr's supported method of installation.

Images for amd64 & arm64 are available under `jorenn92/maintainerr` and `ghcr.io/jorenn92/maintainerr`.
Expand All @@ -6,7 +10,7 @@ The containers data location is set as /opt/data. A docker [volume][tooltip] is
[tooltip]: https://docs.docker.com/storage/volumes/#start-a-container-with-a-volume "Click here to be taken to the Docker documentation page on volumes."


> !!! info
!!! info
You have the <font color="orange"> option </font> to define a User and Group ID for running the container. Maintainerr will utilize the user:group setting as it's running user (inside the container), and any files it generates within your host data volume will be associated with this designated user and group. If not explicitly specified, the default UID:GID is set to 1000:1000.
<font color="red">See [Run](#run) and [Compose](#compose) below for examples.</font>

Expand Down Expand Up @@ -54,6 +58,11 @@ The containers data location is set as /opt/data. A docker [volume][tooltip] is

1. This is defined as `host:container`.
2. For this line, you could also use `jorenn92/maintainerr` instead, to use the DockerHub image. The `latest` tag at the end is not required, unless you want to specify which tag to use.
3. The develop branch could be unstable.

??? note "Development Versions"
- `ghcr.io/jorenn92/maintainerr:main` for the develop branch
- `jorenn92/maintainerr:develop` for the Docker Hub development image.

### Updating

Expand Down Expand Up @@ -83,7 +92,6 @@ version: '3'
services:
maintainerr:
image: ghcr.io/jorenn92/maintainerr:latest # (1)!
container_name: maintainerr
user: 1000:1000
volumes:
- type: bind
Expand All @@ -100,6 +108,10 @@ services:
1. For this line, you could also use `jorenn92/maintainerr` instead, to use the DockerHub image. The `latest` tag at the end is not required, unless you want to specify which tag to use.
2. This is defined as `host:container`.

??? note "Development Versions"
- `ghcr.io/jorenn92/maintainerr:main` for the develop branch
- `jorenn92/maintainerr:develop` for the Docker Hub development image.

Save your docker-compose.yml file.
Then, while in the directory where your docker-compose file exists, start all services defined in your Compose file:

Expand All @@ -121,4 +133,4 @@ Then, restart all services defined in the Compose file:
docker compose up -d
```

:material-clock-edit: Last Updated: 5/31/24
:material-clock-edit: Last Updated: 10/10/24
4 changes: 3 additions & 1 deletion docs/Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,6 @@ Maintainerr supports rules across these apps :
- Overseerr
- Radarr
- Sonarr
- Tautulli
- Tautulli :test_tube:{ .dev title="In dev branch only"}

:material-clock-edit: Last Updated: 10/10/24
14 changes: 14 additions & 0 deletions docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
@keyframes dev {
0%, 40%, 80%, 100% {
transform: scale(1);
}
20%, 60% {
transform: scale(1.15);
}
}
.dev {
animation: dev 1500ms infinite;
}
.md-status--recent::after {
mask-image: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><title>plus-circle</title><path d="M17,13H13V17H11V13H7V11H11V7H13V11H17M12,2A10,10 0 0,0 2,12A10,10 0 0,0 12,22A10,10 0 0,0 22,12A10,10 0 0,0 12,2Z" /></svg>');
}
8 changes: 7 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ hooks:
- docs/overrides/hooks/translations.py

# Additional configuration
extra_css:
- stylesheets/extra.css
extra:
annotate:
json: [.s2]
Expand All @@ -110,7 +112,10 @@ extra:
link: https://hub.docker.com/r/jorenn92/maintainerr/
- icon: fontawesome/brands/discord
link: https://discord.gg/WP4ZW2QYwk

status:
new: Recently Added
deprecated: Deprecated
recent: New Updates
# Extensions
markdown_extensions:
- abbr
Expand All @@ -128,6 +133,7 @@ markdown_extensions:
# - customization.md
# - insiders/changelog/*
# - docs/extensions/*
- pymdownx.critic
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
Expand Down