Ethersync

Ethersync aims to enable real-time collaborative editing of local text files. Similar to Etherpads, it facilitates multiple users to work on content simultaneously, enabling applications such as shared notes or pair programming.

This project is funded by NLnet through these subgrants:

• Ethersync

1. Install Nix

   Arch Linux

   Bash

   $ pacman --sync --refresh --noconfirm curl git jq nix

   Debian

   Bash

   $ apt install --yes curl git jq nix

   Ubuntu

   Bash

   $ apt install --yes curl git jq nix

2. Download a configuration file

   # default.nix
   {
     ngipkgs ? import (fetchTarball "https://github.com/ngi-nix/ngipkgs/tarball/main") { },
   }:
   ngipkgs.demo-shell (
     { pkgs, ... }:
   
     {
       programs.ethersync.enable = true;
   
       programs.neovim = {
         enable = true;
         configure = {
           packages.ethersync = {
             start = [
               pkgs.nvim-ethersync
             ];
           };
         };
       };
     }
   
   )
   
3. Enable binary substituters

   Bash

   $ export NIX_CONFIG='substituters = https://cache.nixos.org/ https://ngi.cachix.org/
   trusted-public-keys = cache.nixos.org-1:6nchdd59x431o0gwypbmraurkbj16zpmqfgspcdshjy= ngi.cachix.org-1:n+cal72roc3qqulxihpv+tw5t42whxmmhpragkrsrow='

4. Build and run a virtual machine

   Arch Linux, Debian Sid and Ubuntu 25.04

   Bash

   $ nix-build ./default.nix && ./result

   Debian 12 and Ubuntu 24.04/24.10

   Bash

   $ rev=$(nix-instantiate --eval --attr sources.nixpkgs.rev https://github.com/ngi-nix/ngipkgs/archive/master.tar.gz | jq --raw-output)

   $ nix-shell -I nixpkgs=https://github.com/NixOS/nixpkgs/archive/$rev.tar.gz --packages nix --run "nix-build ./default.nix && ./result"

5. Missing Contribute usage instructions.