Cloned2Preserve
/
TrueChartsClone
mirror of https://github.com/truecharts/charts.git
1
0
Fork 0
Code
TrueChartsClone/charts/stable/invitarr/docs/installation_notes.md

28 lines
1014 B
Markdown
Raw Normal View History

chore(docs): lints some docs, uses front-matter instead of # h1, and fix list items in changelog (#16589) **Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ⚒️ Fixes # <!--(issue)--> front matter is supported by all doc sites (including github markdown rendering and is easier to add extra metadata later on, if we want to. ``` --- title: sometitle --- ``` **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> **📃 Notes:** <!-- Please enter any other relevant information here --> **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [ ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._
2023-12-31 14:24:05 +00:00
---
title: Installation Notes
---
fix(invitarr) code clean up + docs (#4282)
2022-11-02 22:33:03 +00:00
- 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.
:::