Emacs

Docker Setup

There is a Docker image built from this repository that contains Emacs 28 with all packages AOT compiled. Image runs as user core replace your username as required.

docker pull nakkaya/emacs:latest

You can run it using,

docker run \
  --restart=always \
  --name emacsd \
  --detach \
  -p 9090:9090/tcp \
  nakkaya/emacs

If you have python invoke installed you can run more complicated commands,

invoke docker                    # For bares bones version same as above
invoke docker --with-gpu         # Run with GPUs attached
invoke docker --with-host        # Run with host networking
invoke docker --with-passwd 1234 # Set password for Web & SSH login

See,

invoke docker --help

For more options, Either of the following can be used to connect to a running image.

# Connect using
xpra attach tcp://127.0.0.1:9090 --window-close=disconnect
# or
chrome --app=http://127.0.0.1:9090

Service ports/paths used by the image when enabled,

• Xpra: 9090
• SSH: 9090
• WebDAV: /disk
• Jupyter: /jupyter (When enabled.)
• PGAdmin: /pgadmin (When enabled.)
• VScode: /vscode (When enabled.)

Semi Automated Setup

Clone this repository,

git clone [email protected]:nakkaya/emacs.git

Navigate to devops/<your_os> and run the provided install script.

Manual Setup

Clone this repository,

git clone [email protected]:nakkaya/emacs.git

Tell .emacs to load init.el.

(load-file "~/source/emacs/init.el")