From 30811c18605264e8ad4be15946cf182a5f992d02 Mon Sep 17 00:00:00 2001 From: Xstar97 Date: Wed, 31 Aug 2022 03:21:44 -0400 Subject: [PATCH] fix(plaxt): moved to stable and added docs (#3638) * fix(plaxt): move to stable and added docs v2 * Rename README..md to README.md * fix common version back to 10.5.5 * no messaeg Co-authored-by: Stavros kois --- .../{incubator => stable}/plaxt/.helmignore | 0 .../{incubator => stable}/plaxt/CHANGELOG.md | 0 charts/{incubator => stable}/plaxt/Chart.yaml | 19 ++++++------ charts/{incubator => stable}/plaxt/README.md | 0 .../stable/plaxt/docs/installation_notes.md | 29 ++++++++++++++++++ charts/{incubator => stable}/plaxt/icon.png | Bin .../plaxt/questions.yaml | 10 +++--- .../plaxt/templates/common.yaml | 0 .../{incubator => stable}/plaxt/values.yaml | 21 ++++++++----- cspell.config.yaml | 2 ++ 10 files changed, 59 insertions(+), 22 deletions(-) rename charts/{incubator => stable}/plaxt/.helmignore (100%) rename charts/{incubator => stable}/plaxt/CHANGELOG.md (100%) rename charts/{incubator => stable}/plaxt/Chart.yaml (70%) rename charts/{incubator => stable}/plaxt/README.md (100%) create mode 100644 charts/stable/plaxt/docs/installation_notes.md rename charts/{incubator => stable}/plaxt/icon.png (100%) rename charts/{incubator => stable}/plaxt/questions.yaml (95%) rename charts/{incubator => stable}/plaxt/templates/common.yaml (100%) rename charts/{incubator => stable}/plaxt/values.yaml (86%) diff --git a/charts/incubator/plaxt/.helmignore b/charts/stable/plaxt/.helmignore similarity index 100% rename from charts/incubator/plaxt/.helmignore rename to charts/stable/plaxt/.helmignore diff --git a/charts/incubator/plaxt/CHANGELOG.md b/charts/stable/plaxt/CHANGELOG.md similarity index 100% rename from charts/incubator/plaxt/CHANGELOG.md rename to charts/stable/plaxt/CHANGELOG.md diff --git a/charts/incubator/plaxt/Chart.yaml b/charts/stable/plaxt/Chart.yaml similarity index 70% rename from charts/incubator/plaxt/Chart.yaml rename to charts/stable/plaxt/Chart.yaml index 9ba121719c2..e04330b1fd3 100644 --- a/charts/incubator/plaxt/Chart.yaml +++ b/charts/stable/plaxt/Chart.yaml @@ -1,9 +1,3 @@ -annotations: - truecharts.org/SCALE-support: "true" - truecharts.org/catagories: | - - Other - - MediaApp-Other - - MediaServer-Other apiVersion: v2 appVersion: "latest" dependencies: @@ -11,8 +5,8 @@ dependencies: repository: https://library-charts.truecharts.org version: 10.5.6 deprecated: false -description: "This Tools provides a way to keep your watched history synced FROM Plex Server To Trakt.tv (IT will not do history prior to tool Installation) it uses WebHooks to Accomplish this so a PLEX PASS Subscription is needed to use WebHooks.\r\n" -home: https://truecharts.org/docs/charts/incubator/plaxt +description: This Tools provides a way to keep your watched history synced FROM Plex Server To Trakt.tv +home: https://truecharts.org/docs/charts/stable/plaxt icon: https://truecharts.org/img/hotlink-ok/chart-icons/plaxt.png keywords: - plaxt @@ -30,4 +24,11 @@ sources: - https://github.com/XanderStrike/goplaxt - https://hub.docker.com/r/xanderstrike/goplaxt type: application -version: 0.0.22 +version: 1.0.0 +annotations: + truecharts.org/catagories: | + - Other + - MediaApp-Other + - MediaServer-Other + truecharts.org/SCALE-support: "true" + truecharts.org/grade: U diff --git a/charts/incubator/plaxt/README.md b/charts/stable/plaxt/README.md similarity index 100% rename from charts/incubator/plaxt/README.md rename to charts/stable/plaxt/README.md diff --git a/charts/stable/plaxt/docs/installation_notes.md b/charts/stable/plaxt/docs/installation_notes.md new file mode 100644 index 00000000000..af3d67a14f9 --- /dev/null +++ b/charts/stable/plaxt/docs/installation_notes.md @@ -0,0 +1,29 @@ +# Installation Notes + +## TRAKT.TV Setup + +- Please create an [app](https://trakt.tv/oauth/applications/new) in trakt.tv. +- Set the trakt app name to whatever you like for ex: `plaxt`. +- Optionally set an icon, you can download this [icon](https://truecharts.org/img/hotlink-ok/chart-icons/plaxt.png). +- Set the redirect uri to for ex (must end with `/authorize`): +- `https://plaxt.mydomain.com/authorize`. +- `https://my_public_ip:8000/authorize`. +- Set the option `/scrobble` to `true`. +- Copy both the Client ID and Secret as you will need both to setup the `plaxt` chart in the next section. + +## Plaxt Setup + +- Set `TRAKT_ID` with your custom trakt.tv app's client id. +- Set `TRAKT_SECRET` with your trakt.tv app's client secret. + +- After launching the chart it will ask you to add your plex username in `Step 1`. +- Click the `authorize` button to authorize your custom app aka `plaxt` with trakt.tv. +- If successful, you will be given a generated webhook to add to plex in `Step 2`. + +- Go to plex -> settings -> webhooks -> add the webhook. +- Profit. + +Notes: + +- This chart depends on plex webhooks which is a `Plex Pass` feature. +- The upstream project is no longer in development as Trakt has [official support](https://blog.trakt.tv/plex-scrobbler-52db9b016ead) for Plex Webhooks. diff --git a/charts/incubator/plaxt/icon.png b/charts/stable/plaxt/icon.png similarity index 100% rename from charts/incubator/plaxt/icon.png rename to charts/stable/plaxt/icon.png diff --git a/charts/incubator/plaxt/questions.yaml b/charts/stable/plaxt/questions.yaml similarity index 95% rename from charts/incubator/plaxt/questions.yaml rename to charts/stable/plaxt/questions.yaml index a18061cb3d8..547270883b8 100644 --- a/charts/incubator/plaxt/questions.yaml +++ b/charts/stable/plaxt/questions.yaml @@ -12,9 +12,9 @@ questions: # Include{recreate} # Include{controllerExpert} # Include{controllerExpertExtraArgs} - - variable: env + - variable: secretEnv group: "Container Configuration" - label: "Image Environment" + label: "Image Secrets" schema: additional_attrs: true type: dict @@ -66,9 +66,9 @@ questions: # Include{serviceExpert} # Include{serviceList} # Include{persistenceRoot} - - variable: hostpathforkeystore - label: "hostpathforkeystore Storage" - description: "Usually mntuserappdataplaxt" + - variable: config + label: "App Config Storage" + description: "Stores the Application Configuration." schema: additional_attrs: true type: dict diff --git a/charts/incubator/plaxt/templates/common.yaml b/charts/stable/plaxt/templates/common.yaml similarity index 100% rename from charts/incubator/plaxt/templates/common.yaml rename to charts/stable/plaxt/templates/common.yaml diff --git a/charts/incubator/plaxt/values.yaml b/charts/stable/plaxt/values.yaml similarity index 86% rename from charts/incubator/plaxt/values.yaml rename to charts/stable/plaxt/values.yaml index 2f4480dce8d..8548a794970 100644 --- a/charts/incubator/plaxt/values.yaml +++ b/charts/stable/plaxt/values.yaml @@ -1,27 +1,32 @@ -env: - TRAKT_ID: "" - TRAKT_SECRET: "" image: pullPolicy: IfNotPresent repository: tccr.io/truecharts/plaxt tag: latest@sha256:da5223efed05cf981a0a5a4670cfbd609db5c3ad0b4653ba88a6b08a77805cc1 -persistence: - hostpathforkeystore: - enabled: true - mountPath: /app/keystore + +env: + TRAKT_ID: "" + TRAKT_SECRET: "" + podSecurityContext: runAsGroup: 0 runAsUser: 0 + securityContext: readOnlyRootFilesystem: false runAsNonRoot: false + service: main: ports: main: port: 8000 - protocol: TCP + protocol: HTTP targetPort: 8000 +persistence: + config: + enabled: true + mountPath: "/app/keystore" + portal: enabled: true diff --git a/cspell.config.yaml b/cspell.config.yaml index 2e537463436..87a3ed7061b 100644 --- a/cspell.config.yaml +++ b/cspell.config.yaml @@ -104,6 +104,7 @@ words: - photoprism - pihole - plainhost + - plaxt - plex - preconfigured - prefs @@ -157,6 +158,7 @@ words: - tlsstores - traefik - traefikservices + - Trakt - truecharts - truenas - truetool