Docker is software that is used to run software on an isolated environment called a container. Docker is a multiplatform software, and it can be run on Windows, macOS, and Linux. Currently, only x86/x64 architecture processors are supported. If you are not familiar with Docker, we recommend you to check out their website and documentation for further information.
It is fairly easy to set up and run Honeygain on Docker, so we will not go very in-depth on how to use Docker but will mention a couple of tricks that you could use to enhance your Honeygain experience using Docker:
Installing Docker
Learn the basics of how to install Docker on your system before running Honeygain.
Running Honeygain Docker Image
Steps to pull and run the official Honeygain Docker container.
Enabling Auto-Start on System Restart
How to configure the Docker container to start automatically when your machine restarts.
Running Docker Container in the Background
Run your Honeygain container in detached mode for continuous operation.
Running Container in Background + Auto-Start on Restart
Combine running the container in detached mode with auto-start settings for best results.
Error: "Got permission denied while trying to connect to the Docker daemon socket..."
Troubleshooting steps to fix common permission errors with Docker on Linux and Windows.
Content Delivery on Honeygain Docker Container
How to enable and use Content Delivery feature within the Docker container.
Honeygain Docker Container on ARM
Specific instructions and compatibility notes for running on ARM-based devices like Raspberry Pi.
Installing Docker
Docker can be downloaded and installed from their official website here. Select your operating system and follow the instructions.
Running Honeygain Docker Image
After installing Docker, pull and run the Honeygain container:
docker pull honeygain/honeygain
docker run honeygain/honeygain -tou-get
docker run honeygain/honeygain -tou-accept -email ACCOUNT_EMAIL -pass ACCOUNT_PASSWORD -device DEVICE_NAME
Replace ACCOUNT_EMAIL, ACCOUNT_PASSWORD, and DEVICE_NAME accordingly. Use unique DEVICE_NAME for each container.
Enabling Auto-Start on System Restart
To enable auto-start:
docker run --restart unless-stopped honeygain/honeygain -tou-accept -email ACCOUNT_EMAIL -pass ACCOUNT_PASSWORD -device DEVICE_NAME
If updating an existing container:
docker update --restart unless-stopped CONTAINER_ID
docker ps -a # to find CONTAINER_ID
docker ps # to list active containers
Running Docker Container in the Background
Run container detached:
docker run -d honeygain/honeygain -tou-accept -email ACCOUNT_EMAIL -pass ACCOUNT_PASSWORD -device DEVICE_NAME
To run an existing container in background:
docker run -d CONTAINER_ID
Background + Auto-Start Mode
Run container in background and enable auto-start:
docker run -d --restart unless-stopped honeygain/honeygain -tou-accept -email ACCOUNT_EMAIL -pass ACCOUNT_PASSWORD -device DEVICE_NAME
Permission Denied Error
If you see Got permission denied while trying to connect to the Docker daemon socket..., try:
sudo docker ...
Content Delivery Support
Content Delivery is currently not available on Docker containers but may be introduced in the future.
Docker on ARM Architecture
Starting from Honeygain version 0.8.1, Honeygain supports ARM devices like Raspberry Pi. You can run Honeygain on such devices just like a regular desktop.
If you experience issues setting up Honeygain on Docker, please contact us using this form.