From 126e4a62f8b2f8f478c234a8c9992fc92ab7b1b8 Mon Sep 17 00:00:00 2001 From: Steven Date: Tue, 5 Sep 2023 21:00:06 +0800 Subject: [PATCH] chore: update install guide --- docs/install.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/docs/install.md b/docs/install.md index 50c1671..1b50f0c 100644 --- a/docs/install.md +++ b/docs/install.md @@ -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. -## Upgrade +### Upgrade To upgrade Slash to latest version, stop and remove the old container first: @@ -38,27 +38,22 @@ docker pull yourselfhosted/slash:latest 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 -Assume that docker compose is deployed in the `/opt/slash` directory +Assume that docker compose is deployed in the `/opt/slash` directory. ```bash mkdir -p /opt/slash && cd /opt/slash curl -#LO https://github.com/boojack/slash/raw/main/docker-compose.yml 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. -## Upgrade +### Upgrade ```bash cd /opt/slash docker compose pull docker compose up -d -``` \ No newline at end of file +```