Deployment
Docker
Spin up Keep with docker-compose latest images
The easiest way to start keep is is with docker-compose:
curl https://raw.githubusercontent.com/keephq/keep/main/start.sh | sh
start.sh
#!/bin/bash
# Keep install script for docker compose
echo "Creating state directory."
mkdir -p state
test -e state
echo "Changing directory ownership to non-privileged user."
chown -R 999:999 state || echo "Unable to change directory ownership, changing permissions instead." && chmod -R 0777 state
which curl &> /dev/null || echo "curl not installed"
curl https://raw.githubusercontent.com/keephq/keep/main/docker-compose.yml --output docker-compose.yml
curl https://raw.githubusercontent.com/keephq/keep/main/docker-compose.common.yml --output docker-compose.common.yml
docker compose up -d
The docker-compose.yml contains 3 services:
- keep-backend - a fastapi service that as the API server.
- keep-frontend - a nextjs app that serves as Keep UI interface.
- keep-websocket-server - Soketi (a pusher compatible websocket server) for real time alerting.