docker.el

Emacs integration for Docker!

Supports docker containers, images, volumes, networks, docker-machine and docker-compose.

Screenshots

List images

Image run

Installation

The recommended way to install docker.el is through MELPA.

Here is a example use-package configuration:

(use-package docker
  :ensure t
  :bind ("C-c d" . docker))

Quickstart

Use M-x docker, select a resource then then mark or unmark items using the following keybindings (for moremarking possibilities, check out https://github.com/politza/tablist):

Then select an action and follow the instructions.

Supported commands

• docker container: attach, cp, diff, inspect, kill, logs, pause, rename, restart, rm, start, stop, unpause
• docker image: inspect, pull, push, rm, run, tag
• docker network: rm
• docker volume: rm
• docker-machine: create, env, restart, rm, start, stop
• docker-compose: build, config, create, down, exec, logs, pull, push, remove, restart, run, start, stop, up

You can also enter dired or open a file inside a container or volume.

Customizations

Thanks to transient, all the transients arguments can be set temporarily orpermanently. See https://magit.vc/manual/transient/Saving-Values.html#Saving-Values for more information.

There are also hidden items (e.g on M-x docker where you could specify the host or TLS settings), seehttps://magit.vc/manual/transient/Enabling-and-Disabling-Suffixes.html for more information.

Here is a list of other customizations you can set:

Changing the Default Arguments for docker run

You can match on the repository name for an image to customize the initial infix arguments via docker-image-run-custom-args:

(add-to-list
   'docker-image-run-custom-args
   `("^postgres" ("-e POSTGRES_PASSWORD=postgres" . ,docker-run-default-args)))

So when docker run is called on an image whose repository name matches the regular expression ^postgres, the option "-e POSTGRES_PASSWORD=postgres" will appear as set along with the defaults specified by docker-run-default-args.

FAQ

How to use docker-machine under OSX / MacOS?

The following configuration is required (some of it can probably be simplified by usinghttps://github.com/purcell/exec-path-from-shell).

(setenv "PATH" (concat (getenv "PATH") ":/usr/local/bin"))
(setq exec-path (append exec-path '("/usr/local/bin")))
;; Use "docker-machine env box" command to find out your environment variables
(setenv "DOCKER_TLS_VERIFY" "1")
(setenv "DOCKER_HOST" "tcp://10.11.12.13:2376")
(setenv "DOCKER_CERT_PATH" "/Users/foo/.docker/machine/machines/box")
(setenv "DOCKER_MACHINE_NAME" "box")

This is necessary and useful if you use docker-machine.Notice though that there is also a native MacOS Docker implementation(now called Docker Desktop)which does not depend on VirtualBox and which does not require these tweaks.

Contributions

They are very welcome, either as suggestions or as pull requests by opening ticketson the issue tracker.