Skip to content

Commit d2b1df5

Browse files
committed
📄 readme: updated docker instructions
1 parent ee4e47d commit d2b1df5

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

README.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -99,16 +99,18 @@ If you need help, you can join the [support server](https://discord.gg/3ej9JrkF3
9999

100100
### Docker
101101

102-
First, clone this repository and build your image:
103-
```
104-
git clone https://github.com/Kyrela/FixTweetBot.git
105-
cd FixTweetBot
106-
docker build -t fixtweetbot .
102+
First, pull the latest image from Docker Hub:
103+
104+
```bash
105+
docker pull kyrela/fixtweetbot:latest
107106
```
108107

109-
Copy the example docker-compose and fill it with your bot token. Change the default passwords to random strings.
110-
You do not need to repeat the same configuration in `override.config.yml` - but you can still create one if you want. To use it, uncomment the proper lines
111-
in your docker-compose:
108+
Then, create a directory for the configuration, and copy the [example docker-compose](docker-compose.example.yml)
109+
and fill it with your bot token. Change the default passwords to random strings.
110+
111+
You do not need to repeat the same configuration in `override.config.yml`, but you can still create one if you want
112+
to override default settings.
113+
To use it, uncomment the proper lines in your docker-compose:
112114

113115
```yaml
114116
# uncomment and create file if you want to override any default settings
@@ -120,18 +122,18 @@ Then simply run `docker compose up -d`.
120122

121123
#### Available environment variables
122124

123-
| Environmental variable | Comment |
124-
|------------------------|---------------------------------------------------------------------------------|
125-
| UID | User ID used inside the container. Default value: 1000 |
126-
| GID | Group ID used inside the container. Default value: 1000 |
127-
| DATABASE_HOST | Database hostname. Unset by default. |
128-
| DATABASE_PORT | Database port. Unset by default. |
129-
| DATABASE_NAME | Database name. Unset by default. |
130-
| DATABASE_USER | Database user. Unset by default. |
131-
| DATABASE_PASSWORD | Database password. Unset by default. |
132-
| DATABASE_DRIVER | Database driver. Default value: "mysql" |
133-
| DISCORD_TOKEN | Your bot's token. |
134-
| DEV_GUILD | _Optional_: Server ID that you want to use for controlling your bot's instance. |
125+
| Environment variable | Comment |
126+
|----------------------|---------------------------------------------------------------------------------|
127+
| UID | User ID used inside the container. Default value: 1000 |
128+
| GID | Group ID used inside the container. Default value: 1000 |
129+
| DATABASE_HOST | Database hostname. Unset by default. |
130+
| DATABASE_PORT | Database port. Unset by default. |
131+
| DATABASE_NAME | Database name. Unset by default. |
132+
| DATABASE_USER | Database user. Unset by default. |
133+
| DATABASE_PASSWORD | Database password. Unset by default. |
134+
| DATABASE_DRIVER | Database driver. Default value: "mysql" |
135+
| DISCORD_TOKEN | Your bot's token. |
136+
| DEV_GUILD | _Optional_: Server ID that you want to use for controlling your bot's instance. |
135137

136138
### Bare metal
137139

0 commit comments

Comments
 (0)