Skip to content

Commit ddb6c72

Browse files
committed
readme: update, add notes
1 parent 4b8d998 commit ddb6c72

1 file changed

Lines changed: 23 additions & 13 deletions

File tree

README.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,7 @@ By using this image you accept the [Privacy statement of the TeamSpeak Systems G
2828

2929
*Discord is © Hammer & Chisel Inc. This product and the author is in no way affiliated with Hammer & Chisel Inc.*
3030

31-
## Installation
32-
33-
### docker-compose
34-
35-
Download the [docker-compose file](https://github.com/SinusBot/docker/blob/master/docker-compose.yml) in it's own directory and start it with `docker-compose up`.
31+
## Usage
3632

3733
### docker
3834

@@ -72,6 +68,10 @@ This can be done as described in the following:
7268
sinusbot/docker
7369
```
7470

71+
### docker-compose
72+
73+
Download the [docker-compose file](docker-compose.yml) in it's own directory and start it with `docker-compose up`.
74+
7575
#### Tags
7676

7777
- `latest` is the default tag
@@ -130,14 +130,7 @@ To upgrade a container you need to remove and re-run it as shown below.
130130
docker pull sinusbot/docker
131131
```
132132

133-
3. Create a new container with your volumes.
134-
135-
```bash
136-
docker run --rm -d -p 8087:8087 \
137-
-v /opt/sinusbot/scripts:/opt/sinusbot/scripts \
138-
-v /opt/sinusbot/data:/opt/sinusbot/data \
139-
--name sinusbot sinusbot/docker
140-
```
133+
3. Create a new container with your volumes as described in the [usage](#usage) section above.
141134

142135
*It is also possible to automate this process by running [Watchtower](https://containrrr.github.io/watchtower/).*
143136

@@ -224,3 +217,20 @@ networks:
224217
mynetwork:
225218
driver: bridge
226219
```
220+
221+
## Development
222+
223+
### Deploy Version
224+
225+
To build and release a new version, clone this repository and run:
226+
227+
```bash
228+
docker login
229+
./release_as_latest.sh <VERSION>
230+
```
231+
232+
Replace `<VERSION>` with the version, e.g. `1.0.0-beta.10-202ee4d`.
233+
234+
This will build and upload the following tags: `<VERSION>-discord`, `<VERSION>`, `discord`, `latest`
235+
236+
`./release_version.sh` does the same but without setting `discord`, `latest`.

0 commit comments

Comments
 (0)