From ce48afa3c28f2d8ffe6128d381d918844e059fae Mon Sep 17 00:00:00 2001 From: Xstar97 Date: Wed, 2 Nov 2022 18:33:03 -0400 Subject: [PATCH] fix(invitarr) code clean up + docs (#4282) --- charts/incubator/invitarr/Chart.yaml | 21 ++++++------ .../invitarr/docs/installation_notes.md | 25 +++++++++++++++ charts/incubator/invitarr/questions.yaml | 32 +++++++++---------- charts/incubator/invitarr/values.yaml | 18 +++++++---- 4 files changed, 62 insertions(+), 34 deletions(-) create mode 100644 charts/incubator/invitarr/docs/installation_notes.md diff --git a/charts/incubator/invitarr/Chart.yaml b/charts/incubator/invitarr/Chart.yaml index 45a6c7d5eb4..ce4d3f579a5 100644 --- a/charts/incubator/invitarr/Chart.yaml +++ b/charts/incubator/invitarr/Chart.yaml @@ -1,11 +1,3 @@ -annotations: - truecharts.org/SCALE-support: "true" - truecharts.org/catagories: | - - HomeAutomation - - Tools-Utilities - - Other - - MediaApp-Other - - MediaServer-Other apiVersion: v2 appVersion: "latest" dependencies: @@ -13,7 +5,7 @@ dependencies: repository: https://library-charts.truecharts.org version: 10.7.13 deprecated: false -description: Invitarr is a chatbot that invites discord users to plex. You can also automate this bot to invite discord users to plex once a certain role is given to a user or the user can also be added manually. +description: A chatbot that invites discord users to plex. home: https://truecharts.org/docs/charts/incubator/invitarr icon: https://truecharts.org/img/hotlink-ok/chart-icons/invitarr.png keywords: @@ -21,8 +13,6 @@ keywords: - HomeAutomation - Tools-Utilities - Other - - MediaApp-Other - - MediaServer-Other kubeVersion: ">=1.16.0-0" maintainers: - email: info@truecharts.org @@ -34,4 +24,11 @@ sources: - https://github.com/Sleepingpirates/Invitarr - https://hub.docker.com/r/piratify/invitarr type: application -version: 0.0.32 +version: 0.0.33 +annotations: + truecharts.org/catagories: | + - HomeAutomation + - Tools-Utilities + - Other + truecharts.org/SCALE-support: "true" + truecharts.org/grade: U diff --git a/charts/incubator/invitarr/docs/installation_notes.md b/charts/incubator/invitarr/docs/installation_notes.md new file mode 100644 index 00000000000..04304aba20d --- /dev/null +++ b/charts/incubator/invitarr/docs/installation_notes.md @@ -0,0 +1,25 @@ +# Installation Notes + +- Create a discord bot [here](https://discord.com/developers/applications). +- Enable Intents else bot will not _DM_ users after they get the role. +- Invite the bot with `Administrator` permission. + +- In your discord server run the following commands in any channel that the bot has access to, you will be DM by the bot for the reply: + +- `.setupplex` + + - Authenticate with your _**plex**_ `username` | `email` | `token` and `password`. + +- `.roleadd @role` + + - This is the role that will trigger the bot to get the email from the user and invite them to Plex. + +- `.setuplibs` + - By default when a user is invited to plex they will have access to all Libraries. However you can bypass that with the above command. + - a comma separated list. Remember this is case sensitive. No spaces before or after comma. Example: `Animes,Movies,Tv Shows`. + +:::note + +Auto Plex invite only works when someone is given this role and won't message the user if they already have this role. + +::: diff --git a/charts/incubator/invitarr/questions.yaml b/charts/incubator/invitarr/questions.yaml index b0a97584b22..7bff59bfcef 100644 --- a/charts/incubator/invitarr/questions.yaml +++ b/charts/incubator/invitarr/questions.yaml @@ -11,15 +11,15 @@ questions: # Include{controllerExpert} # Include{controllerExpertExtraArgs} - variable: env - group: "Container Configuration" - label: "Image Environment" + group: Container Configuration + label: Image Environment schema: additional_attrs: true type: dict attrs: - variable: token - label: "token" - description: "Discord Bot Token" + label: token + description: Discord Bot Token schema: type: string default: "" @@ -29,8 +29,8 @@ questions: # Include{serviceList} # Include{persistenceRoot} - variable: config - label: "config Storage" - description: "Config path" + label: App Config Storage + description: Stores the Application Configuration. schema: additional_attrs: true type: dict @@ -42,42 +42,42 @@ questions: # Include{security} # Include{securityContextAdvancedRoot} - variable: privileged - label: "Privileged mode" + label: Privileged mode schema: type: boolean default: false - variable: readOnlyRootFilesystem - label: "ReadOnly Root Filesystem" + label: ReadOnly Root Filesystem schema: type: boolean default: false - variable: allowPrivilegeEscalation - label: "Allow Privilege Escalation" + label: Allow Privilege Escalation schema: type: boolean default: false - variable: runAsNonRoot - label: "runAsNonRoot" + label: runAsNonRoot schema: type: boolean default: false # Include{securityContextAdvanced} # Include{podSecurityContextRoot} - variable: runAsUser - label: "runAsUser" - description: "The UserID of the user running the application" + label: runAsUser + description: The UserID of the user running the application schema: type: int default: 0 - variable: runAsGroup - label: "runAsGroup" - description: The groupID this App of the user running the application" + label: runAsGroup + description: The groupID this App of the user running the application schema: type: int default: 0 - variable: fsGroup - label: "fsGroup" - description: "The group that should own ALL storage." + label: fsGroup + description: The group that should own ALL storage. schema: type: int default: 568 diff --git a/charts/incubator/invitarr/values.yaml b/charts/incubator/invitarr/values.yaml index 4b8528c2f02..8adef9f04e4 100644 --- a/charts/incubator/invitarr/values.yaml +++ b/charts/incubator/invitarr/values.yaml @@ -1,16 +1,15 @@ -env: - token: "" image: pullPolicy: IfNotPresent repository: tccr.io/truecharts/invitarr tag: latest@sha256:5b4cef064f29027cdfdcd6e31e1a35e5c6cc977f1e22b276af8e8224fc72caa2 -persistence: - config: - enabled: true - mountPath: /app/app/config + +env: + token: "" + podSecurityContext: runAsGroup: 0 runAsUser: 0 + probes: liveness: enabled: false @@ -18,9 +17,11 @@ probes: enabled: false startup: enabled: false + securityContext: readOnlyRootFilesystem: false runAsNonRoot: false + service: main: enabled: false @@ -28,5 +29,10 @@ service: main: enabled: false +persistence: + config: + enabled: true + mountPath: /app/app/config + portal: enabled: false