aykhans/slash-e
1
0
Fork 0
mirror of https://github.com/aykhans/slash-e.git synced 2025-04-20 22:07:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: update install guide

Browse Source
This commit is contained in:
Steven 2023-09-05 21:00:06 +08:00
parent 78282dab4d
commit 126e4a62f8
1 changed files with 5 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/install.md
View File

@ -16,7 +16,7 @@ docker run -d --name slash --publish 5231:5231 --volume ~/.slash/:/var/opt/slash
This will start Slash in the background and expose it on port `5231`. Data is stored in `~/.slash/`. You can customize the port and data directory. This will start Slash in the background and expose it on port `5231`. Data is stored in `~/.slash/`. You can customize the port and data directory.
## Upgrade ### Upgrade
To upgrade Slash to latest version, stop and remove the old container first: To upgrade Slash to latest version, stop and remove the old container first:
@ -38,24 +38,19 @@ docker pull yourselfhosted/slash:latest
Finally, restart Slash by following the steps in [Docker Run](#docker-run). Finally, restart Slash by following the steps in [Docker Run](#docker-run).
# Self-hosting Slash with Docker Compose
## Requirements
The only requirement is a server with Docker installed.
## Docker Compose Run ## Docker Compose Run
Assume that docker compose is deployed in the `/opt/slash` directory Assume that docker compose is deployed in the `/opt/slash` directory.
```bash ```bash
mkdir -p /opt/slash && cd /opt/slash mkdir -p /opt/slash && cd /opt/slash
curl -#LO https://github.com/boojack/slash/raw/main/docker-compose.yml curl -#LO https://github.com/boojack/slash/raw/main/docker-compose.yml
docker compose up -d docker compose up -d
``` ```
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. 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.
## Upgrade ### Upgrade
```bash ```bash
cd /opt/slash cd /opt/slash