drifty/marketplace-bay-bot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cleaned up docs

Browse Source
This commit is contained in:
driftywinds
2025-05-12 11:39:59 +00:00
parent 08a9e8c96a
commit beceac3a71
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -2,7 +2,11 @@
My vibe code for the marketplace bay bot My vibe code for the marketplace bay bot
## 1. How to use bare metal on linux : -
#### There are mainly two ways to run the bot, bare metal (you install dependencies to the machine) or docker compose (you containerize the bot).
#### This is how you set them up : -
## 1) Bare Metal on Linux : -
- Download the repo, cd into the directory - Download the repo, cd into the directory
- Choose which bot you want to run - - Choose which bot you want to run -
``` ```
@@ -23,7 +27,7 @@ python3 <name of the bot you want to run for group or for DMs>.py
- press ```ctrl + b + d``` and profit - press ```ctrl + b + d``` and profit
- to go back into the console at any time run ```tmux a``` - to go back into the console at any time run ```tmux a```
## 2. How to use with Docker Compose (recommended) : - ## 2) Docker Compose (recommended) : -
- Download the ```compose.yml``` file from the docker directory - Download the ```compose.yml``` file from the docker directory
- download ```example.env```, change it accordingly and rename it to ```.env``` - download ```example.env```, change it accordingly and rename it to ```.env```
- edit the line for container_name and image in the ```compose.yml``` file to use the image you want to run from one of these - - edit the line for container_name and image in the ```compose.yml``` file to use the image you want to run from one of these -
@@ -35,7 +39,7 @@ python3 <name of the bot you want to run for group or for DMs>.py
```ghcr.io/driftywinds/mpbot:latestGT``` ```ghcr.io/driftywinds/mpbot:latestGT```
- run ```docker compose up -d``` - run ```docker compose up -d```
## 3. How to build a docker image : - ## 2.1) How to build the docker images : -
- download / clone the repo - download / clone the repo
- move / copy the respective Dockerfile to the root of the repo - move / copy the respective Dockerfile to the root of the repo
- run ```docker build . -f Dockerfile-GTbot.py -t your-image-name:tag``` - run ```docker build . -f Dockerfile-GTbot.py -t your-image-name:tag```