Skip to content

Commit

Permalink
docs: Review readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
haydenyoung committed May 9, 2024
1 parent 94a319a commit 05600c3
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Voyager is a pinning peer for OrbitDB.

Voyager uses Libp2p protocols to send messages for pinning and unpinning databases. Once pinned, a database is replicated by Voyager so that it is available from the pinning peer rather than directly from the originating peer. Unpinning removes the replicated database from the pinning peer.

OrbitDB Voyager is designed to be run on systems with guaranteed uptime and are publicly available. For example, a browser-based app running a local OrbitDB database may deploy one or more pinning peers to ensure the database is available once the browser is offline.
OrbitDB Voyager is designed to run on systems with guaranteed uptime and public availability. For example, a browser-based app running a local OrbitDB database may rely on one or more pinning peers to ensure the database is available when the browser peer goes offline.

Voyager, like OrbitDB, does not have a traditional server/client architecture and so terms "server" and "client" do not apply. Therefore, in keeping with OrbitDB's "planetary" naming convention, the pinning peer is called "Orbiter" and the interface which a 3rd party developer will use to communicate with the pinning peer is called "Lander".

Expand Down Expand Up @@ -50,6 +50,6 @@ If successful, an OK response will be sent. If unpinning fails, an error will be

## Allowing and Denying Pins

Voayger uses simple ALLOW/DENY policies to authorize the sending of messages to the pinning protocol by remote peers.
Voyager uses simple ALLOW/DENY policies to authorize the sending of messages to the pinning protocol by remote peers.

Voayger can either be run in Allow mode where anyone can send a message except those who appear in the denied list or Deny mode which will only allow messages from an explicit list of peers.
Voyager can either be run in ALLOW ALL mode where anyone can send a message except those who appear in the denied list or DENY ALL mode which will only allow messages from an explicit list of peers. The default access mode is DENY ALL.

0 comments on commit 05600c3

Please sign in to comment.