remoteit/docker-extension repository overview

⁠Remote.it Docker Extension (Docker Jumpbox)

A Remote.it Docker Extension docker image. You can install this docker image in two ways:

• Docker Extension
• Docker Container

⁠Docker Extension

Open your Docker Dashboard from your Docker Desktop app

• Go to the Extensions menu item on the left side
• Click on the "Add Extensions" menu item
• In "Browse" search bar enter "Remote.It"
• Select the "Remote.It" extension
• Click on "Install" and then "Open" after the Remote.It Docker Extension is installed
• Click on "Get Registration Code" and log into your RemoteIt account that you want to register this device with
• Once you have logged in you will see it generate a registration code and ask you to open Docker Desktop
• Once you get back to Docker Desktop the new registration code should be automatically populated for you
• Just click the "Register" button

⁠Docker Container

You can run this same image on server based docker hosts that do not have the Docker Desktop installed. For example you could install this on a Raspberry Pi running just the Docker daemon. In order to do that you can run the following command:

docker run \
  -d \
  --name myname \
  --hostname myname \
  -e R3_REGISTRATION_CODE="<registration_code>" \
  -v $PWD/myname:/etc/remoteit \
  -v /var/run/docker.sock:/var/run/docker.sock \
  --restart unless-stopped \
  --pull always \
  remoteit/docker-extension

Here is a breakdown of the command:

• -d = run this container in detached mode in the background.
• --name myname = This sets the container name. Otherwise a name is generated for you.
• --hostname myname = This sets the hostname within the container. The hostname is used by Remote.it to set the Device Name during registration.
• -e R3_REGISTRATION_CODE="<registration_code>" = This is your registration_code that you can get from the Remote.it Desktop by clicking on the + sign in the Device list and selecting "Docker" from the "Add a Device" section.
• -v $PWD/myname:/etc/remoteit = The path on the Docker host that will be mapped to the /etc/remoteit folder within the container. Anything which is written to the /etc/remoteit folder in the container will show up on the Docker host. That way when you stop or kill the container you can restart it and the Remote.it Agent will find the existing /etc/remoteit/config.json.
• -v /var/run/docker.sock:/var/run/docker.sock = Mount the docker socket inside the container.
• --restart unless-stopped = This insures that the remoteit-agent docker container restarts after a shutdown of the docker daemon such as a power on/off or reboot of the docker host.
• --pull always = Always pull the image when running so we get the actual "latest" even if we have already pulled it before on this system.