Files
velociraptor-docker/README.md
ifoster 62e5f14296
Some checks failed
Build and Push Docker Image / build-and-push (push) Has been cancelled
Update README.md
2025-08-01 17:14:53 +00:00

31 lines
1.2 KiB
Markdown

# velociraptor-docker
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`
- Change credential values in `.env` as desired
- `docker-compose up` (or `docker-compose up -d` for detached)
- Access the Velociraptor GUI via https://\<hostip\>:8889
- Default u/p is `admin/admin`
- This can be changed by running:
`docker exec -it velociraptor ./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`. There should also be versions of each automatically repacked based on the server configuration.
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`
To pull a specific version of the Docker image:
`docker pull wlambert/velociraptor:0.73.4`
a