fix(invitarr) code clean up + docs (#4282)

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

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.
+
+:::

charts/incubator/invitarr/questions.yaml

@@ -11,15 +11,15 @@ questions:
 # Include{controllerExpert}
 # Include{controllerExpertExtraArgs}
   - variable: env
-    group: "Container Configuration"
+    group: Container Configuration
-    label: "Image Environment"
+    label: Image Environment
     schema:
       additional_attrs: true
       type: dict
       attrs:
         - variable: token
-          label: "token"
+          label: token
-          description: "Discord Bot Token"
+          description: Discord Bot Token
           schema:
             type: string
             default: ""
@@ -29,8 +29,8 @@ questions:
 # Include{serviceList}
 # Include{persistenceRoot}
         - variable: config
-          label: "config Storage"
+          label: App Config Storage
-          description: "Config path"
+          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"
+          label: runAsUser
-          description: "The UserID of the user running the application"
+          description: The UserID of the user running the application
           schema:
             type: int
             default: 0
         - variable: runAsGroup
-          label: "runAsGroup"
+          label: runAsGroup
-          description: The groupID this App of the user running the application"
+          description: The groupID this App of the user running the application
           schema:
             type: int
             default: 0
         - variable: fsGroup
-          label: "fsGroup"
+          label: fsGroup
-          description: "The group that should own ALL storage."
+          description: The group that should own ALL storage.
           schema:
             type: int
             default: 568

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:
+env:
-    enabled: true
+  token: ""
-    mountPath: /app/app/config
+
 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