Skip to content

Commit 2876cad

Browse files
committed
feat: Support docker compose deployment
1 parent 9a491e2 commit 2876cad

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

docker-compose.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
version: '3'
2+
services:
3+
slash:
4+
image: yourselfhosted/slash:latest
5+
container_name: slash
6+
ports:
7+
- 5231:5231
8+
volumes:
9+
- slash:/var/opt/slash
10+
restart: unless-stopped
11+
12+
volumes:
13+
slash:

docs/install.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,28 @@ docker pull yourselfhosted/slash:latest
3737
```
3838

3939
Finally, restart Slash by following the steps in [Docker Run](#docker-run).
40+
41+
# Self-hosting Slash with Docker Compose
42+
43+
## Requirements
44+
45+
The only requirement is a server with Docker installed.
46+
47+
## Docker Compose Run
48+
49+
Assume that docker compose is deployed in the `/opt/slash` directory
50+
51+
```bash
52+
mkdir -p /opt/slash && cd /opt/slash
53+
curl -#LO https://github.com/boojack/slash/raw/main/docker-compose.yml
54+
docker compose up -d
55+
```
56+
This will start Slash in the background and expose it on port `5231`. Data is stored in Docker Volume `slash_slash`. You can customize the port and backup your volume.
57+
58+
## Upgrade
59+
60+
```bash
61+
cd /opt/slash
62+
docker compose pull
63+
docker compose up -d
64+
```

0 commit comments

Comments
 (0)