Difference between revisions of "TRAMP"

From WikEmacs
Jump to: navigation, search
(Created page with "Emacs' TRAMP feature (Transparent Remote file Access, Multiple Protocol) is an extremely powerful tool for editing files that exist on remote systems, or require access using ...")
 
Line 3: Line 3:
 
Some of the things that TRAMP can do include:
 
Some of the things that TRAMP can do include:
  
* Editing files on a remote development server over SSH (e.g. <code>/ssh:remote-user@remote.box:/path/to/my/file</code>)
+
* Editing files on a remote development server over SSH (e.g. <tt>/ssh:remote-user@remote.box:/path/to/my/file</tt>)
* Editing files on your local machine as root via sudo (e.g. <code>/sudo::/etc/some/config/file</code>)
+
* Editing files on your local machine as root via sudo (e.g. <tt>/sudo::/etc/some/config/file</tt>)
* Editing files on a remote server as root via sudo over an SSH connection from another remote machine that exists within a DMZ (requires a little bit of configuration)
+
* Editing files on a remote server as root via sudo over an SSH connection from another remote machine that exists within a DMZ (requires some configuration, see below)
  
 
TRAMP is included with Emacs and described in the manual.
 
TRAMP is included with Emacs and described in the manual.
 +
 +
== Multiple hops ==
 +
 +
To set up multiple hop connections you will need to do a little bit of configuration.
 +
 +
As an example, let's assume that you want to edit a file located at <tt>/etc/httpd/conf/httpd.conf</tt> as root on a remote server at dev.example.com. You have a regular user account <tt>chris<tt> on the development sever, but you need to use sudo to gain root access before editing the file.
 +
 +
Put the following into your configuration files:
 +
 +
;; Guard to ensure that TRAMP is available
 +
(if (locate-library "tramp")
 +
    (eval-after-load "tramp"
 +
 +
      ;; The actual TRAMP configuration
 +
      '(add-to-list 'tramp-default-proxies-alist
 +
                    '("\\`dev\\.example\\.com\\'"
 +
                      "\\`chris\\'"
 +
                      "/ssh:%h:"))))
 +
 +
After this is evaluated, Emacs knows that the hostname dev.example.com must be accessed over SSH by a user called chris.
 +
 +
If you now try to find <tt>/sudo:dev.example.com:/etc/httpd/conf/httpd.conf</tte> Emacs will automatically create the SSH connection first, prompting you for your password if necessary. Then it will prompt you for your sudo password. Once this is all done you will be able to modify the buffer as necessary. Saving the buffer will do what you expect: it will update the file on the remote server.
 +
 +
Hops can be chained, making this feature extremely powerful.

Revision as of 11:57, 26 March 2012

Emacs' TRAMP feature (Transparent Remote file Access, Multiple Protocol) is an extremely powerful tool for editing files that exist on remote systems, or require access using a different user account from your main Emacs session, or both.

Some of the things that TRAMP can do include:

  • Editing files on a remote development server over SSH (e.g. /ssh:remote-user@remote.box:/path/to/my/file)
  • Editing files on your local machine as root via sudo (e.g. /sudo::/etc/some/config/file)
  • Editing files on a remote server as root via sudo over an SSH connection from another remote machine that exists within a DMZ (requires some configuration, see below)

TRAMP is included with Emacs and described in the manual.

Multiple hops

To set up multiple hop connections you will need to do a little bit of configuration.

As an example, let's assume that you want to edit a file located at /etc/httpd/conf/httpd.conf as root on a remote server at dev.example.com. You have a regular user account chris<tt> on the development sever, but you need to use sudo to gain root access before editing the file.

Put the following into your configuration files:

;; Guard to ensure that TRAMP is available
(if (locate-library "tramp")
    (eval-after-load "tramp"

      ;; The actual TRAMP configuration
      '(add-to-list 'tramp-default-proxies-alist
                    '("\\`dev\\.example\\.com\\'"
                      "\\`chris\\'"
                      "/ssh:%h:"))))

After this is evaluated, Emacs knows that the hostname dev.example.com must be accessed over SSH by a user called chris.

If you now try to find <tt>/sudo:dev.example.com:/etc/httpd/conf/httpd.conf</tte> Emacs will automatically create the SSH connection first, prompting you for your password if necessary. Then it will prompt you for your sudo password. Once this is all done you will be able to modify the buffer as necessary. Saving the buffer will do what you expect: it will update the file on the remote server.

Hops can be chained, making this feature extremely powerful.