PrivateCoffee/matrix-gptbot
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

refactor: streamline Docker setup in README
All checks were successful
Docker CI/CD / Docker Build and Push to Docker Hub (push) Successful in 9m12s
Details

Browse source 
Removed detailed Docker setup instructions, opting to simplify the Docker usage section by retaining only the Docker Compose method. This change aims to declutter the README and encourage a more standardized setup process for users, reducing potential confusion and maintaining focus on the primary installation method via Docker Compose. The update includes a minor adjustment to the database initialization step, ensuring users are guided to prepare their environment fully before running the bot. This revision makes the setup process more approachable and efficient, especially for newcomers.

By directing users to the `Running` section for config file setup instructions, we maintain consistency and avoid duplicative content, keeping the README streamlined and more manageable.
This commit is contained in:
Kumi 2024-04-23 17:47:26 +02:00
parent 5a9332d635
commit 91a028d50b
Signed by: kumi
GPG key ID: ECBCC9082395383F
1 changed files with 5 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
README.md
View file

@ -54,45 +54,9 @@ to install the latest version from the Git repository.
#### Docker #### Docker
##### From Docker Hub
A Docker image is available on Docker Hub. You can use it to run the bot in a
Docker container.
```shell
# Create a config file from the provided example
cp config.dist.ini config.ini
# Edit the config file to your needs
# Run the bot
docker run -v config.ini:/app/config.ini kumitterer/matrix-gptbot
```
##### Building the image
Alternatively, you can use the provided `Dockerfile` to build and run the bot
locally.
```shell
# Clone the repository
git clone https://git.private.coffee/privatecoffee/matrix-gptbot.git
cd matrix-gptbot
# Build the Docker image
docker build -t matrix-gptbot .
# Create a config file
cp config.dist.ini config.ini
# Edit the config file to your needs
# Run the bot
docker run -v config.ini:/app/config.ini matrix-gptbot
```
##### Docker Compose
A `docker-compose.yml` file is provided that you can use to run the bot with A `docker-compose.yml` file is provided that you can use to run the bot with
Docker Compose. You will need to create a `config.ini` file as described above. Docker Compose. You will need to create a `config.ini` file as described in the
`Running` section.
```shell ```shell
# Clone the repository # Clone the repository
@ -103,6 +67,9 @@ cd matrix-gptbot
cp config.dist.ini config.ini cp config.dist.ini config.ini
# Edit the config file to your needs # Edit the config file to your needs
# Initialize the database file
sqlite3 database.db "SELECT 1"
# Optionally, create Pantalaimon config # Optionally, create Pantalaimon config
cp pantalaimon.example.conf pantalaimon.conf cp pantalaimon.example.conf pantalaimon.conf
# Edit the Pantalaimon config file to your needs # Edit the Pantalaimon config file to your needs