HedgeDoc is a real-time collaborative markdown editor that allows multiple users to edit documents together. In this tutorial, we will look at how to install HedgeDoc on nixOS latest.
Before installing HedgeDoc on nixOS latest, you need to have the following:
To install HedgeDoc, you need to have Docker installed on your nixOS instance. You can install Docker using the following command:
$ nix-env -iA nixos.docker
By default, Docker will be added to the systemd services and started on boot.
Next, clone the HedgeDoc repository by running the following command:
$ git clone https://github.com/hedgedoc/hedgedoc.git
After cloning the HedgeDoc repository, navigate to the hedgedoc
directory and create a .env
file using the following command:
$ cd hedgedoc
$ cp .env.example .env
Edit the .env
file to match your requirements. For example, if you want to change the port on which HedgeDoc runs, change the PORT
variable in the .env
file to the port number you want to use.
To start HedgeDoc, run the following command in the hedgedoc
directory:
$ sudo docker-compose up -d
You can now access HedgeDoc from your web browser by navigating to http://<nixOS-instance-IP-address>:3000
.
Once HedgeDoc is running, you can start creating documents. Click on the Create a new document
button to create a new document. You can then share the document with collaborators by sharing the URL with them.
Congratulations! You have successfully installed HedgeDoc on nixOS latest. You can now start collaborating on documents with your friends or colleagues in real-time.
If you want to self-host in an easy, hands free way, need an external IP address, or simply want your data in your own hands, give IPv6.rs a try!
Alternatively, for the best virtual desktop, try Shells!