Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/faizyy01/Invitarr
Plex Discord Bot to invite a user to a plex server
https://github.com/faizyy01/Invitarr
Last synced: about 1 month ago
JSON representation
Plex Discord Bot to invite a user to a plex server
- Host: GitHub
- URL: https://github.com/faizyy01/Invitarr
- Owner: faizyy01
- License: gpl-3.0
- Created: 2020-05-12T16:55:19.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-20T01:01:47.000Z (about 2 years ago)
- Last Synced: 2024-08-11T14:06:16.428Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 503 KB
- Stars: 96
- Watchers: 6
- Forks: 32
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://discord.gg/mYbCgtDTrh)
[](https://hub.docker.com/r/piratify/invitarr)
Invitarr
=================
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.
### Features
- Ability to invite users to plex from discord
- Fully automatic invites using roles
- Ability to kick users from plex if they leave the discord server or if their role is taken away.
- Ability to view the database in discord and to edit it.
- Fully configurable via a web portal
Commands:
```
.plexinvite
This command is used to add an email to plex
.plexremove
This command is used to remove an email from plex
.dbls
This command is used to list Invitarrs database
.dbadd <@user>
This command is used to add exsisting users email and discord id to the DB.
.dbrm
This command is used to remove a record from the Db. Use -db ls to determine record position. ex: -db rm 1
```
# Unraid Installation
1. Ensure you have the Community Applications plugin installed.
2. Inside the Community Applications app store, search for Invitarr.
3. Click the Install Button.
4. On the following Add Container screen, add discord bot token.
5. Click apply
6. Finish setting up using [Setup Commands](#after-bot-has-started)
# Setup
**1. Enter discord bot token in bot.env**
**2. Install requirements**
```
pip3 install -r requirements.txt
```
**3. Start the bot**
```
python3 Run.py
```
# Docker Setup & Start
1. First pull the image
```
docker pull piratify/invitarr:latest
```
2. Make the container
```
docker run -d --restart unless-stopped --name invitarr -v /path to config:/app/app/config -e "token=YOUR_DISCORD_TOKEN_HERE" piratify/invitarr:latest
```
# After bot has started
# Setup Commands:
```
.setupplex
This command is used to setup plex login.
.roleadd <@role>
These role(s) will be used as the role(s) to automatically invite user to plex
.setuplibs (optional)
This command is used to setup plex libraries. Default is set to all.
```
Refer to the [Wiki](https://github.com/Sleepingpirates/Invitarr/wiki) for detailed steps.
**Enable Intents else bot will not Dm users after they get the role.**
https://discordpy.readthedocs.io/en/latest/intents.html#privileged-intents