Skip to main content

Docker-remote is a wrapper for docker-compose to manage compositions on a remote machine easily.

Project description

# Docker Remote

<a href="https://opensource.org/licenses/MIT">
<img align="right" src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT">
</a>

![](docs/logo.png)

[Compose]: https://github.com/docker/compose
[Machine]: https://docs.docker.com/machine/

Remote is a tool for managing Docker applications via [Compose] on another
machine. It uses SSH tunnels to connect your Docker and Docker Compose client
with your Docker Host. It is useful as an alternative to [Machine] or to
deploy an app on a server without manually loggin in via SSH.

$ cat docker-compose.yml
version: '3.4'
services:
web:
image: nginx
x-docker-remote:
project:
name: myapp

$ docker-remote compose up --build --detach
$ docker-remote docker ps

Docker Remote sets the `DOCKER_HOST` environment variable when invoking
`docker` or `docker-compose`. You can use `docker-remote shell` to enter
a shell with a tunnel set up and the environment variable set, then omit
the `docker-remote` prefix on Docker commands.

$ docker-remote shell
Setting up a docker-compose alias...

$ alias && echo $DOCKER_HOST
alias docker-compose='docker-remote compose'
tcp://localhost:2375

$ docker ps

The host to which a connection is opened can be specified in the
`x-docker-remote` section of the Docker Compose configuration or in the
`~/.docker-remote.yml` configuration file.

remote:
host: myhost.org
user: me
remotepy: /home/me/.local/bin/docker-remote.core.remotepy

The `remote.remotepy` option is necessary if the `docker-remote.core.remotepy`
command is not in the `PATH` of your user.

Check out the [Documentation](docs/) for installation instructions and
tutorials.

__Features__

* Allows you to compose and manage applications remotely
* Pre-processes your Docker Compose configuration in order to place all
named and relative volume names inside a project directory.
* Ability to automatically add a `dockerhost` hostname to `/etc/hosts` for
all or selected services

---

<p align="center">Copyright &copy; 2018 Niklas Rosenstein</p>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docker-remote-1.1.0.tar.gz (13.8 kB view details)

Uploaded Source

File details

Details for the file docker-remote-1.1.0.tar.gz.

File metadata

  • Download URL: docker-remote-1.1.0.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.7.2

File hashes

Hashes for docker-remote-1.1.0.tar.gz
Algorithm Hash digest
SHA256 27e7656deab7d4ef04a636a045b0d170685a18faca38e100ace05ecdce663aec
MD5 e4892b76030b21f5c949653b54706cb5
BLAKE2b-256 88dee0f81403307d445bb147ece15aa1e01958f1a1a0332c885f79d0d250e7e1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page