Create an Automerge sync server — amsync

Creates a WebSocket server that implements the automerge-repo sync protocol, compatible with JavaScript, Rust, and other Automerge clients.

Usage

amsync_server(
  port = 3030L,
  host = "0.0.0.0",
  data_dir = ".amrg",
  auto_create_docs = TRUE,
  storage_id = NULL,
  tls = NULL
)

Arguments

port: Port to listen on. Default 3030.
host: Host address to bind to. Default "0.0.0.0" (all interfaces).
data_dir: Directory for persistent document storage. Default ".amrg".
auto_create_docs: Logical, whether to auto-create documents when clients request unknown document IDs. Default TRUE.
storage_id: Optional storage ID for this server. If NULL (default), generates a new persistent identity. Set to NA for an ephemeral server (no persistence identity).
tls: (optional) for secure wss:// connections, a TLS configuration object created by nanonext::tls_config().

Value

An amsync_server object inheriting from 'nanoServer', with $start() and $stop() methods.

Details

The returned server inherits from nanonext's nanoServer class and provides $start() and $stop() methods for non-blocking operation.

Examples

if (FALSE) { # interactive()
# Create and start a server
server <- amsync_server()
server$start()

# Server is now running in the background
# ...do other work...

# Stop when done
server$stop()

# Custom port with TLS
cert <- nanonext::write_cert()
tls <- nanonext::tls_config(server = cert$server)
server <- amsync_server(port = 8080, tls = tls)
server$start()
server$stop()
}