From 4a9e5a1844109c995d7b1866b34319617f930230 Mon Sep 17 00:00:00 2001 From: weslambert Date: Sat, 11 Jul 2020 07:41:22 -0400 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d016cc6..94996a7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ # velociraptor-docker -Docker image for Velocidex Velociraptor +Run [Velocidex Velociraptor](https://github.com/Velocidex/velociraptor) server with Docker + +#### Install + +- Ensure [docker-compose](https://docs.docker.com/compose/install/) is installed on the host +- `git clone https://github.com/weslambert/velociraptor-docker` +- `cd velociraptor-docker` +- `docker-compose up` +- Access the Velociraptor GUI via https://\:8889 + - Default u/p is `admin/admin` + - This can be changed by running: `docker exec -it velox ./velociraptor --config server.config.yaml user add user1 user1 --role administrator` + +#### Notes: + +Linux, Mac, and Windows binaries are located in `/velociraptor/clients`, which should be mapped to the host in the `./velociraptor` directory if using `docker-compose` + +Once started, edit `server.config.yaml` in `/velociraptor`, then run `docker-compose down/up` for the server to reflect the changes + +#### Docker image +To pull only the Docker image: + +`docker pull wlambert/velociraptor`