aboutsummaryrefslogtreecommitdiffstats
path: root/README.org
blob: 25a3dc253d8da16f225d8c0a653ed665cd69629c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
* Introduction
=tramp-docker= adds support for =Docker= containers with Emacs’
Tramp system.

* Installation
** ELPA
This package is available on [[https://elpa.gnu.org/packages/nspawn-tramp.html][GNU ELPA]] and can be installed with
=M-x package-install RET tramp-docker RET= from within Emacs itself.

** Direct download
Download this repository to some location, then add the following to
your Emacs initialization:
#+begin_src elisp
  (add-to-list 'load-path "/path/to/tramp-docker")
  (require 'tramp-docker)
#+end_src

* Usage
Call ~tramp-docker-setup~ to add support:
#+begin_src elisp
  (add-hook 'after-init-hook 'tramp-docker-setup)
#+end_src

Use Tramp as normal to access files on a container:
#+begin_example
  C-x C-f /docker:user@container:/path/to/file
#+end_example

** Using podman
To use =podman= as a drop-in replacement for =docker=, customize the
variable =tramp-docker-program=.