Skip to content

Commit a2a9032

Browse files
committed
improve readme and correct update section
1 parent 48312ca commit a2a9032

1 file changed

Lines changed: 34 additions & 23 deletions

File tree

README.md

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
## Installation
1616

17-
By using this image you accept the [Privacy statement of the TeamSpeak Systems GmbH](https://www.teamspeak.com/en/privacy-and-terms) and the license agreement of the SinusBot.
17+
By using this image you accept the [Privacy statement of the TeamSpeak Systems GmbH](https://www.teamspeak.com/en/privacy-and-terms), the [SinusBot Privacy Policy](https://forum.sinusbot.com/help/privacy-policy/) and the license agreement.
1818

1919
### docker-compose
2020

@@ -42,7 +42,7 @@ Additional information on [setting the user](https://docs.docker.com/engine/refe
4242
## Get Password
4343

4444
After starting the SinusBot docker image with `docker run` an ID will be returned in the next line.
45-
Use the command `docker logs <ID>` (replace `<ID>` with the long container ID) to print out the logs of the container.
45+
Use the command `docker logs sinusbot` to print out the logs of the container.
4646
The beginning of the log should contain your credentials:
4747

4848
```txt
@@ -54,7 +54,7 @@ PLEASE MAKE SURE TO CHANGE THE PASSWORD DIRECTLY AFTER YOUR FIRST LOGIN!!!
5454
[...]
5555
```
5656

57-
## Password overriding
57+
## Override Password
5858

5959
By setting the `OVERRIDE_PASSWORD` environment variable you can override the password of the SinusBot. Usage:
6060

@@ -68,8 +68,9 @@ docker run -d -p 8087:8087 \
6868

6969
## License
7070

71-
To use your license, which you've got from the [forums](https://forum.sinusbot.com/license) just drop the `private.dat` into the data folder.
72-
After that you can restart the SinusBot and the license should be applied.
71+
To use your [license](https://sinusbot.github.io/docs/licenses/), which you've got from the [License Page in the Forum](https://forum.sinusbot.com/license), you need to save the `private.dat` into the data folder.
72+
73+
After restarting the container (`docker restart sinusbot`) your licensed instances should appear automatically.
7374

7475
## Discord only image
7576

@@ -83,25 +84,41 @@ docker run -d -p 8087:8087 \
8384
--name sinusbot sinusbot/docker:discord
8485
```
8586

86-
## Updating the image
87+
## Updating
8788

88-
Run the following command to update the image to the latest version:
89+
Docker containers themselves should not store application data, instead the data is stored in volumes (in this case `scripts` and `data`).
90+
To upgrade a container you need to remove and re-run it as shown below.
8991

90-
```bash
91-
docker pull sinusbot/docker
92-
```
92+
1. Stop and remove the old container.
9393

94-
After that you just need to restart your container, by executing the following command:
94+
```bash
95+
docker stop sinusbot
96+
docker rm sinusbot
97+
```
9598

96-
```bash
97-
docker restart CONTAINER_NAME
98-
```
99+
2. Pull the latest image:
100+
101+
```bash
102+
docker pull sinusbot/docker
103+
```
104+
105+
3. Create a new container with your volumes.
106+
107+
```bash
108+
docker run --rm -d -p 8087:8087 \
109+
-v scripts:/opt/sinusbot/scripts \
110+
-v data:/opt/sinusbot/data \
111+
--name sinusbot sinusbot/docker
112+
```
113+
114+
*It is also possible to automate this process by running [Watchtower](https://containrrr.github.io/watchtower/).*
99115

100116
## Text-to-Speech
101117

102-
Per default, there is the Chromium Text-to-Speech engine pre installed. It can be simply enabled by setting the `TTS.Enabled` property in the `config.ini` of the `data` volume to `true`. It's per default disabled due performance issues / memory costs.
118+
The Chromium Text-to-Speech engine is pre-installed but disabled by default due to higher cpu/memory usage.
103119

104-
Once it's enabled it can be used by setting in the Instance settings `en-US` or `de-DE` as locale.
120+
To enable it you simply need to set the `TTS.Enabled` property to `true` in the `config.ini` stored in the `data` volume (`/opt/sinusbot/data`) and restart your container (`docker restart sinusbot`).
121+
Once it's enabled it can be used by setting the locale to `en-US` or `de-DE` in the instance settings.
105122
106123
## Other Docker registries
107124
@@ -115,12 +132,6 @@ Can be pulled by using:
115132
docker pull quay.io/sinusbot/docker
116133
```
117134
118-
Also the discord image is available on the `discord` tag:
119-
120-
```bash
121-
docker pull quay.io/sinusbot/docker:discord
122-
```
123-
124135
For using docker-compose with [quay.io](https://quay.io) just replace `sinusbot/docker` with `quay.io/sinusbot/docker`. Example:
125136
126137
```yaml
@@ -137,7 +148,7 @@ sinusbot:
137148
138149
## docker-compose with TeamSpeak 3 Server
139150
140-
In the SinusBot you have to use the network alias `teamspeak.docker.local` as hostname.
151+
In the SinusBot you have to use the network alias `teamspeak.docker.local` as hostname.
141152
142153
```yaml
143154
# docker-compose.yml

0 commit comments

Comments
 (0)