OptionaldenylistOptionalenableWhether to enable the experimental remote heads gossiping feature
OptionalisIndicates whether other peers should persist the sync state of this peer. Sync state is only persisted for non-ephemeral peers
OptionalnetworkA list of network adapters (more can be added at runtime).
OptionalpeerOur unique identifier
OptionalsaveThe debounce rate in milliseconds for saving documents. Defaults to 100ms.
Optional ExperimentalshareWhether to share documents with other peers. By default we announce new documents to everyone and allow everyone access to documents, see the documentation for ShareConfig to override this
Note that this is currently an experimental API and will very likely change without a major release.
OptionalshareNormal peers typically share generously with everyone (meaning we sync all our documents with all peers). A server only syncs documents that a peer explicitly requests by ID.
OptionalstorageA storage adapter can be provided, or not
A list of automerge URLs which should never be loaded regardless of what messages are received or what the share policy is. This is useful to avoid loading documents that are known to be too resource intensive.