https://github.com/codefresh-io/remote-docker

A Docker container to securely control a remote docker daemon CLI using ssh forwarding, no SSL setup needed.
https://github.com/codefresh-io/remote-docker

Last synced: 8 months ago
JSON representation

A Docker container to securely control a remote docker daemon CLI using ssh forwarding, no SSL setup needed.

• Host: GitHub
• URL: https://github.com/codefresh-io/remote-docker
• Owner: codefresh-io
• License: apache-2.0
• Created: 2017-02-27T10:53:24.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-06-14T18:24:14.000Z (almost 4 years ago)
• Last Synced: 2025-04-25T14:59:43.534Z (about 1 year ago)
• Language: Shell
• Size: 20.5 KB
• Stars: 16
• Watchers: 14
• Forks: 12
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# remote-docker

#### Build

[![Codefresh build status]( https://g.codefresh.io/api/badges/build?repoOwner=codefresh-io&repoName=remote-docker&branch=master&pipelineName=remote-docker&accountName=codefresh-inc&type=cf-2)]( https://g.codefresh.io/repositories/codefresh-io/remote-docker/builds?filter=trigger:build;branch:master;service:58b405b7a6eaef0100345945~remote-docker)

#### Image

[![](https://images.microbadger.com/badges/image/codefresh/remote-docker.svg)](http://microbadger.com/images/codefresh/remote-docker) [![](https://images.microbadger.com/badges/version/codefresh/remote-docker.svg)](http://microbadger.com/images/codefresh/remote-docker) [![](https://images.microbadger.com/badges/commit/codefresh/remote-docker.svg)](http://microbadger.com/images/codefresh/remote-docker) 

A Docker container to securely control a remote docker daemon CLI using ssh forwarding, no SSL setup needed.

## Setup

In order to use `remote-docker` with your Docker server, you need to configure SSH-key based authentication for your Docker server machine. There are lots of tutorials available: you can use [this](https://www.digitalocean.com/community/tutorials/how-to-configure-ssh-key-based-authentication-on-a-linux-server) for example.

You should add you SSH public key to your Docker server and keep private key for using in `remote-docker` container. You can pass this key either as file (using `-v` option) or as environment variable (`-e SSH_KEY=...`). 

From now on, you should be able to run any `docker` command on your server through SSH tunneling. 

## Usage

Lets assume you want to control the docker daemon on your `webserver.com` server. You need to run a `codefresh/remote-docker` Docker container, passing `ssh` private key file to it, like this:

    $ docker run -it --rm -v ${HOME}/.ssh/id_rdocker:/root/.ssh/id_rdocker codefresh/remote-docker rdocker user@webserver.com

Or you can pass `ssh` key as the environment variable (assuming you've setup `SSH_KEY`)

    $ docker run -it --rm -e SSH-KEY=${SSH_KEY} codefresh/remote-docker rdocker user@webserver.com

This will open a new `bash` session, within the `codefresh/remote-docker` container, with a new `DOCKER_HOST` variable setup. Any `docker` command you execute will take place on the remote docker daemon.

To test the connection run:

    docker:user@webserver.com bash-4.3# docker info

Check the `Name:` field it should have the remote hostname .... That's it!!!

You could for example run `docker build` to build an image on the remote host and then `docker save -o myimage.tar image_name` to store it locally.

Or run `docker exec -it container_name bash` to open a shell session on a remote container. Even bash auto-completion works ok.

To stop controlling the remote daemon and close the ssh forwarding, just exit the newly created bash session (press `Ctrl+D`).

You can also execute any `docker` command directly, without openning a `bash` shell in the `codefresh/remote-docker` container.

    $ docker run -it --rm -v ${HOME}/.ssh/id_rdocker:/root/.ssh/id_rdocker codefresh/remote-docker rdocker user@webserver.com docker info

### Custom SSH port

Redefine `SSH_PORT` environment variable if you are using a different port than `22` (set by default).

## Used software

- Copy of `rdocker.sh` script (MIT license) from (dvddarias/rdocker)[https://github.com/dvddarias/rdocker]