- Feature 1: Feature 1 description.
- Feature 2: Feature 2 description.
- Ensure Python >=3.11 is installed. Download it here.
- Clone this repository or download the zip file.
- Open a terminal in the folder where you cloned the repository or extracted the zip file.
- Run
pip install -r requirements.txt
to install the dependencies. - Open the file ".env.template" and complete all variables:
TOKEN
: The token of your bot. Obtain it from the Discord Developer Portal.OWNER_ID
: Your Discord ID.SUPPORT_SERVER
: The ID of your support server. The bot must be a member of this server to create an invite if someone requires support.
- Rename the file ".env.template" to ".env".
- Run
python3 main.py
orpython main.py
to start the bot.
Ensure Docker is installed. Download it from the Docker website.
- Open the
docker-compose.yml
file and update the environment variables as needed (such asTOKEN
,OWNER_ID
, andSUPPORT_SERVER
). - In the terminal, run the following command from the cloned folder to start the bot:
docker-compose up -d
.
- Clone this repository or download the zip file.
- Open a terminal in the cloned or extracted zip file.
- Run
docker build -t basis .
to build the Docker image.
- Open a terminal.
- Run the bot with the command below:
- Modify the variables according to your requirements.
- Set the
TOKEN
, andOWNER_ID
.
You only need to expose the port -p 5000:5000
, if you want to use an external tool, to test, if the bot is running.
In this case, you need to call the /health
endpoint.
docker run -d \
-e SUPPORT_SERVER=ID_OF_SUPPORTSERVER \
-e TOKEN=BOT_TOKEN \
-e OWNER_ID=DISCORD_ID_OF_OWNER \
--name Hercules \
--restart any \
--health-cmd="curl -f http://localhost:5000/health || exit 1" \
--health-interval=30s \
--health-timeout=10s \
--health-retries=3 \
--health-start-period=40s \
-p 5000:5000 \
-v hercules_log:/app/Basis/Logs \
ghcr.io/serpensin/discordbots-basis:latest