diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d8f41e6..356bd26 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -4,6 +4,7 @@ on: push: branches: - 'main' + - 'develop' release: type: [published] pull_request: @@ -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: @@ -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 }} @@ -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' \ No newline at end of file diff --git a/.gitignore b/.gitignore index 4c6900d..995082d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .cache action_execute.sh ascii.txt +action_execute_dev.sh diff --git a/docs/Collections.md b/docs/Collections.md index 460ff49..10cfa5c 100644 --- a/docs/Collections.md +++ b/docs/Collections.md @@ -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 + diff --git a/docs/Common.md b/docs/Common.md index 6b56b21..156ba43 100644 --- a/docs/Common.md +++ b/docs/Common.md @@ -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). @@ -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 \ No newline at end of file + 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 diff --git a/docs/Configuration.md b/docs/Configuration.md index b4b1641..f7cfb9a 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -1,3 +1,5 @@ + + All configuration is done inside the application, no extra config is required in files.
At first boot you will be redirected to the settings page. @@ -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. @@ -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 \ No newline at end of file +:material-clock-edit: Last Updated: 10/10/24 \ No newline at end of file diff --git a/docs/Contributing.md b/docs/Contributing.md index 2cb92da..8f56f11 100644 --- a/docs/Contributing.md +++ b/docs/Contributing.md @@ -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 + diff --git a/docs/Glossary.md b/docs/Glossary.md index 5903fc8..a966103 100644 --- a/docs/Glossary.md +++ b/docs/Glossary.md @@ -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) @@ -526,4 +526,6 @@ The key is used for identification in Yaml rule files. - Key: Tautulli.sw_allEpisodesSeenBy - Availability: shows, seasons -- Type: text[] \ No newline at end of file +- Type: text[] + +:material-clock-edit: Last Updated: 10/10/24 diff --git a/docs/Installation.md b/docs/Installation.md index a5c7dc7..96aab5e 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -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`. @@ -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 option 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. See [Run](#run) and [Compose](#compose) below for examples. @@ -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 @@ -83,7 +92,6 @@ version: '3' services: maintainerr: image: ghcr.io/jorenn92/maintainerr:latest # (1)! - container_name: maintainerr user: 1000:1000 volumes: - type: bind @@ -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: @@ -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 diff --git a/docs/Introduction.md b/docs/Introduction.md index 5afdb08..f263408 100644 --- a/docs/Introduction.md +++ b/docs/Introduction.md @@ -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 diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..f68a054 --- /dev/null +++ b/docs/stylesheets/extra.css @@ -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,plus-circle'); + } diff --git a/mkdocs.yml b/mkdocs.yml index be18918..0508955 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -97,6 +97,8 @@ hooks: - docs/overrides/hooks/translations.py # Additional configuration +extra_css: + - stylesheets/extra.css extra: annotate: json: [.s2] @@ -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 @@ -128,6 +133,7 @@ markdown_extensions: # - customization.md # - insiders/changelog/* # - docs/extensions/* + - pymdownx.critic - pymdownx.arithmatex: generic: true - pymdownx.betterem: