Update README.md

This commit is contained in:
weslambert
2020-07-11 07:41:22 -04:00
committed by GitHub
parent 795770e676
commit 4a9e5a1844

View File

@@ -1,2 +1,23 @@
# velociraptor-docker # 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://\<hostip\>: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`