File: tramp-container.el.html
Allows Tramp access to environments provided by Docker and similar programs.
## Usage
Open a file on a running Docker container:
C-x C-f /docker:USER@CONTAINER:/path/to/file
C-x C-f /dockercp:USER@CONTAINER:/path/to/file
or Podman:
C-x C-f /podman:USER@CONTAINER:/path/to/file
C-x C-f /podmancp:USER@CONTAINER:/path/to/file
Where:
USER is the user on the container to connect as (optional).
CONTAINER is the container to connect to.
"docker" and "podman" are inline methods, "dockercp" and "podmancp"
are out-of-band methods.
Open file in a Kubernetes container:
C-x C-f /kubernetes:[CONTAINER.]POD[%NAMESPACE]:/path/to/file
Where:
POD is the pod to connect to.
CONTAINER is the container to connect to (optional).
By default, the first container in that pod will
be used.
NAMESPACE is the namespace to be used (optional).
Open a file on an existing Toolbox container:
C-x C-f /toolbox:CONTAINER:/path/to/file
Where:
CONTAINER is the container to connect to (optional).
If the container is not running, it is started. If no container is specified, the default Toolbox container is used.
Open a file on an existing Distrobox container:
C-x C-f /distrobox:CONTAINER:/path/to/file
Where:
CONTAINER is the container to connect to.
If the container is not running, it is started.
Open a file on a running Flatpak sandbox:
C-x C-f /flatpak:SANDBOX:/path/to/file
Where:
SANDBOX is the running sandbox to connect to.
It could be an application ID, an instance ID, or a PID.
Open a file on a running Apptainer instance:
C-x C-f /apptainer:INSTANCE:/path/to/file
Where:
INSTANCE is the running instance to connect to.
Open a file on a running systemd-nspawn container:
C-x C-f /nspawn:USER@CONTAINER:/path/to/file
Where:
USER is the user on the container to connect as (optional)
CONTAINER is the container to connect to
Defined variables (23)
tramp-apptainer-method | Tramp method name to connect to Apptainer instances. |
tramp-apptainer-program | Name of the Apptainer client program. |
tramp-distrobox-method | Tramp method name to connect to Distrobox containers. |
tramp-distrobox-no-container-regexp | Regexp matching missing distrobox error message. |
tramp-distrobox-program | Name of the Distrobox client program. |
tramp-docker-method | Tramp method name to connect to Docker containers. |
tramp-docker-program | Name of the Docker client program. |
tramp-dockercp-method | Tramp method name to connect to Docker containers. |
tramp-flatpak-method | Tramp method name to connect to Flatpak sandboxes. |
tramp-flatpak-program | Name of the Flatpak client program. |
tramp-kubernetes--host-name-regexp | The CONTAINER.POD%NAMESPACE syntax of kubernetes host names in Tramp. |
tramp-kubernetes--name-regexp | Regexp matching kubernetes names. |
tramp-kubernetes-context | Context of Kubernetes. |
tramp-kubernetes-method | Tramp method name to connect to Kubernetes containers. |
tramp-kubernetes-namespace | Namespace of Kubernetes. |
tramp-kubernetes-program | Name of the Kubernetes client program. |
tramp-nspawn-method | Tramp method name to connect to systemd-nspawn containers. |
tramp-nspawn-program | Name of the machinectl program. |
tramp-podman-method | Tramp method name to connect to Podman containers. |
tramp-podman-program | Name of the Podman client program. |
tramp-podmancp-method | Tramp method name to connect to Podman containers. |
tramp-toolbox-method | Tramp method name to connect to Toolbox containers. |
tramp-toolbox-program | Name of the Toolbox client program. |