/automerge-repo-sync-server

Primary LanguageJavaScriptMIT LicenseMIT

Automerge Repo Sync Server

A very simple automerge-repo synchronization server. It pairs with the websocket client protocol found in @automerge/automerge-repo-network-websocket.

The server is an unsecured Express app. It is partly for demonstration purposes but it's also a reasonable way to run a public sync server.

Running the sync server

npx @automerge/automerge-repo-sync-server

The server is configured with environment variables. There are two options:

  • PORT - the port to listen for websocket connections on
  • DATA_DIR - the directory to store saved documents in
  • USE_HTTPS - "true" if server should use https/wss; requires HTTPS_CERT and HTTPS_KEY to be configured
  • HTTPS_CERT - path to SSL certificate
  • HTTPS_KEY - path to SSL certificate key

Contributors

Originally written by @pvh.