Skip to content

Commit

Permalink
docs: Added instructions for installing new Keep from scratch in dock…
Browse files Browse the repository at this point in the history
…er (#3105)

Co-authored-by: Tal <[email protected]>
  • Loading branch information
congto and talboren authored Jan 23, 2025
1 parent 7aafdf1 commit 2855363
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/deployment/docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,36 @@ The docker-compose.yml contains 3 services:
- [keep-backend](https://console.cloud.google.com/artifacts/docker/keephq/us-central1/keep/keep-api?project=keephq) - a fastapi service that as the API server.
- [keep-frontend](https://console.cloud.google.com/artifacts/docker/keephq/us-central1/keep/keep-ui?project=keephq) - a nextjs app that serves as Keep UI interface.
- [keep-websocket-server](https://docs.soketi.app/getting-started/installation/docker) - Soketi (a pusher compatible websocket server) for real time alerting.

### Reinstall Keep with the option to refresh from scratch
`Caution:` This usage context will refresh from the beginning and Keep's data and settings will be erased

For cases where you need to test many different options or simply want to reinstall Keep from scratch using docker compose without spending a lot of time, that is, without repeating the steps of installing docker, downloading the installer.. .. run the commands according to the previous instructions.

Follow these steps

#### Step1: Stop, Clear container, network, volume, image.
In the directory containing the docker compose file you downloaded, say `/root/`

```
docker-compose down
docker-compose down --rmi all
docker-compose down -v
docker system prune -a --volumes
```

#### Step2: Clear Config db, config file in state folder.

```
rm -rf state/*
``
#### Step 3: Run again
```
docker compose up -d
```

0 comments on commit 2855363

Please sign in to comment.