/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

Running in Docker

Run in docker using image hosted by GitHub container registry:

docker run -d --name syncserver -p 3030:3030 ghcr.io/automerge/automerge-repo-sync-server:main

cleanup after:

docker stop syncserver
docker rm syncserver

Contributors

Originally written by @pvh.