Docker workflow

You can use neuron without installing it by trying the Docker image sridca/neuron. The image is built automatically from the development version of neuron.

You will need to install Docker if you do not already have it installed.

In order to quickly get started, try:

mkdir ~/zettelkasten
cd ~/zettelkasten
echo "hello world" >
touch neuron.dhall  # Mark this a neuron directory
docker run --rm -t -i -p 8080:8080 -v $(pwd):/notes sridca/neuron neuron gen -ws

This will run the neuron server on the current directory which can be accessed at http://localhost:8080. The docker image operates on /notes as the current working directory, which is where you are expected to mount your notes directory.


macOS users may want to try the Whalebrew package, but note that it may not be up to date.