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
- Running Honeygain Docker image
- Enabling auto-start on system restart
- Running Docker container in the background
- Running Honeygain Docker container in the background and enabling auto-start on restart
- Error: "Got permission denied while trying to connect to the Docker daemon socket..."
- Content Delivery on Honeygain Docker container
- Honeygain Docker container on ARM
Installing Docker
Docker can be downloaded and installed from their official website here. Just click on the operating system that you wish to install Docker on and follow the instructions.
Running Honeygain Docker image
Once you have installed Docker on your host machine, we can now pull the Honeygain docker image from our official Docker Hub and start it. You can run one Honeygain Docker container on one device/network. On our Docker Hub, you can read how to run the Honeygain Docker image and more information about it. However, if you do not wish to read through a complete Honeygain Docker image documentation, here is a shorter version on how to run Honeygain on Docker:
- Pull Docker image
docker pull honeygain/honeygain
- Open Honeygain Terms of Use. If you agree with our Terms of Use, please continue.
docker run honeygain/honeygain -tou-get
- Start Honeygain Docker container
docker run honeygain/honeygain -tou-accept -email ACCOUNT_EMAIL -pass ACCOUNT_PASSWORD -device DEVICE_NAME
Replace ACCOUNT_EMAIL with your Honeygain account email
Replace ACCOUNT_PASSWORD with your Honeygain account password
Replace DEVICE_NAME with a name that you would like to give to your Docker container. This name will be visible on the Dashboard.
NOTE: Use different DEVICE_NAME for every container that you create.
Enabling auto-start on system restart
To run Honeygain Docker container with auto-start (if you restart your device, Docker will automatically run Honeygain container), run Honeygain container using this command:
docker run --restart unless-stopped honeygain/honeygain -tou-accept -email ACCOUNT_EMAIL -pass ACCOUNT_PASSWORD -device DEVICE_NAME
If you already have an active and running Honeygain container, you can update it so that it would start automatically on the next restart using this command:
docker update --restart unless-stopped CONTAINER_ID
Replace CONTAINER_ID with a unique Honeygain container id. You can check the Container ID running this command:
docker ps -a
This will output all containers that there are on your device, both active and inactive. To see only active containers, run this command:
docker ps
Running Honeygain Docker container in the background
If you wish to run the Honeygain Docker container in the background and not to have the Terminal window open the whole time, you can run the container in detached mode by adding -d flag after docker run:
docker run -d honeygain/honeygain -tou-accept -email ACCOUNT_EMAIL -pass ACCOUNT_PASSWORD -device DEVICE_NAME
If you already have a running Docker container that you would like to run in the background, you would need to kill it (Ctrl + C will do the trick) and then run this command:
docker run -d CONTAINER_ID
Replace CONTAINER_ID with a unique Honeygain container id. You can check the Container ID running this command:
docker ps -a
This will output all containers that there are on your device, both active and inactive. To see only active containers, run this command:
docker ps
Running Honeygain Docker container in the background and enabling auto-start on restart
To run Honeygain Docker container in the background mode and enable auto-start on system restart, run the following command:
docker run -d --restart unless-stopped honeygain/honeygain -tou-accept -email ACCOUNT_EMAIL -pass ACCOUNT_PASSWORD -device DEVICE_NAME
Error: "Got permission denied while trying to connect to the Docker daemon socket..."
If you get an error message saying "Got permission denied while trying to connect to the Docker daemon socket...", try running Docker as superuser using sudo:
sudo docker ...
Content Delivery on Honeygain Docker container
Currently Content Delivery is not available on our Docker containers, however, we might introduce it in the future.
Honeygain Docker container on ARM
From now on, starting with Honeygain version 0.8.1 of the application, we support the ARM architecture, and it is possible to run Honeygain on a Raspberry PI or any other similar mini-PCs as on a regular desktop device.
If you encounter any issues or difficulties while setting up Honeygain on Docker, please get in touch with us using this form here.