mirror of
https://github.com/jarulsamy/Plex-Bot.git
synced 2024-08-19 15:01:55 +02:00
📝 Format fixes
This commit is contained in:
Joshua Arulsamy
parent
33bbf21bab
commit
4aadd886d5
126
README.md
126
README.md
@ -3,7 +3,7 @@
|
||||
[](http://perso.crans.org/besson/LICENSE.html)
|
||||
|
||||
|
||||
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
|
||||
|
||||
|
||||
A Python-based Plex music bot for discord.
|
||||
|
||||
@ -13,106 +13,105 @@ A Python-based Plex music bot for discord.
|
||||
|
||||
Plex-Bot runs entirely in a Docker container. Ensure you have Docker and docker-compose installed according to the official Docker [documentation](https://docs.docker.com/get-docker/).
|
||||
|
||||
1. Create a new folder and `cd` into it:
|
||||
1. Create a new folder and `cd` into it:
|
||||
|
||||
```
|
||||
$ mkdir Plex-Bot
|
||||
$ cd Plex-Bot
|
||||
```
|
||||
```bash
|
||||
mkdir Plex-Bot
|
||||
cd Plex-Bot
|
||||
```
|
||||
|
||||
2. Make a `docker-compose.yml` file or use this sample:
|
||||
2. Make a `docker-compose.yml` file or use this sample:
|
||||
|
||||
```yml
|
||||
version: "3"
|
||||
services:
|
||||
plex-bot:
|
||||
container_name: "PlexBot"
|
||||
image: jarulsamy/plex-bot:latest
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- TZ=America/Denver
|
||||
# Required dir for configuration files
|
||||
volumes:
|
||||
- "./config:/config:ro"
|
||||
restart: "unless-stopped"
|
||||
```
|
||||
```yml
|
||||
version: "3"
|
||||
services:
|
||||
plex-bot:
|
||||
container_name: "PlexBot"
|
||||
image: jarulsamy/plex-bot:latest
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- TZ=America/Denver
|
||||
# Required dir for configuration files
|
||||
volumes:
|
||||
- "./config:/config:ro"
|
||||
restart: "unless-stopped"
|
||||
```
|
||||
|
||||
3. Create a configuration folder:
|
||||
3. Create a new `config` folder and create a config file like this::
|
||||
|
||||
Create a new `config` folder and create a config file like this:
|
||||
```bash
|
||||
mkdir config
|
||||
cd config
|
||||
touch config.yaml
|
||||
```
|
||||
|
||||
```
|
||||
$ mkdir config
|
||||
$ cd config
|
||||
```
|
||||
```yml
|
||||
# Create a file called config.yaml with the following contents
|
||||
|
||||
```yml
|
||||
# Create a file called config.yaml with the following contents
|
||||
root:
|
||||
log_level: "info"
|
||||
|
||||
root:
|
||||
log_level: "info"
|
||||
discord:
|
||||
prefix: "?"
|
||||
token: "<BOT_TOKEN>"
|
||||
log_level: "debug"
|
||||
|
||||
discord:
|
||||
prefix: "?"
|
||||
token: "<BOT_TOKEN>"
|
||||
log_level: "debug"
|
||||
plex:
|
||||
base_url: "<BASE_URL>"
|
||||
token: "<PLEX_TOKEN>"
|
||||
library_name: "<LIBRARY_NAME>"
|
||||
log_level: "debug"
|
||||
```
|
||||
|
||||
plex:
|
||||
base_url: "<BASE_URL>"
|
||||
token: "<PLEX_TOKEN>"
|
||||
library_name: "<LIBRARY_NAME>"
|
||||
log_level: "debug"
|
||||
```
|
||||
4. Create a Discord bot application:
|
||||
|
||||
4. Create a Discord bot application:
|
||||
1. Go to the Discord developer portal, [here](https://discord.com/developers/applications).
|
||||
|
||||
* Go to the Discord developer portal, [here](https://discord.com/developers/applications).
|
||||
2. Log in or create an account
|
||||
|
||||
* Log in or create an account
|
||||
3. Click New App
|
||||
|
||||
* Click New App
|
||||
4. Fill in App Name and anything else you'd like to include
|
||||
|
||||
* Fill in App Name and anything else you'd like to include
|
||||
|
||||
* Click Create App
|
||||
5. Click Create App
|
||||
This will provide you with your Client ID and Client Secret
|
||||
|
||||
* Click Create Bot User
|
||||
6. Click Create Bot User
|
||||
This will provide you with your bot Username and Token
|
||||
|
||||
* Fill in the bot token in `config/config.yaml`
|
||||
7. Fill in the bot token in `config/config.yaml`
|
||||
|
||||
5. Get your plex token:
|
||||
5. Get your plex token:
|
||||
|
||||
* Refer to the official [plex documentation](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/).
|
||||
|
||||
* Add it to `config/config.yaml` in the appropiate spot.
|
||||
|
||||
6. Customize remaining settings
|
||||
6. Customize remaining settings
|
||||
|
||||
Set any remaining settings in the config file that you would like. Such as music library, and base url of the Plex server.
|
||||
|
||||
7. Start the service:
|
||||
|
||||
```
|
||||
$ docker-compose up -d
|
||||
```
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
## Logs
|
||||
|
||||
You can view the logs with the following command
|
||||
|
||||
```
|
||||
$ docker-compose logs -f CONTAINER_NAME_OR_ID
|
||||
```bash
|
||||
docker-compose logs -f CONTAINER_NAME_OR_ID
|
||||
|
||||
# For example
|
||||
$ docker-compose logs -f PlexBot
|
||||
docker-compose logs -f PlexBot
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
```text
|
||||
General:
|
||||
kill - Stop the bot.
|
||||
Plex:
|
||||
@ -129,11 +128,4 @@ Type ?help command for more info on a command.
|
||||
You can also type ?help category for more info on a category.
|
||||
```
|
||||
|
||||
## Support
|
||||
|
||||
Reach out to me at one of the following places!
|
||||
|
||||
- Email (Best) at joshua.gf.arul@gmail.com
|
||||
- Twitter at <a href="http://twitter.com/jarulsamy_" target="_blank">`@jarulsamy_`</a>
|
||||
|
||||
* * *
|
||||
|
||||
Loading…
Reference in New Issue
Block a user