diff --git a/README.md b/README.md index 92cc227..b974478 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,8 @@ Adjust the port if required. ## Managing "Orbiter" access +Orbiter will deny all pinning and unpinning requests by default. To allow a user to interact with Orbiter, the user's public key must be added to Orbiter's "allow" list. + Access to Orbiter can be configured using the Voyager binary. To add an authorized public key to Orbiter: @@ -52,7 +54,7 @@ To add an authorized public key to Orbiter: voyager auth add ``` -where identifies a user who can pin databases to this Orbiter. +where identifies a user who can pin databases to this Orbiter. To remove an authorized public key to Orbiter: @@ -68,14 +70,16 @@ List authorized public keys: voyager auth list ``` -If Orbiter's configuration is deployed to a different location, call Voyager with the -d or --directory flag and specify Orbiter's custom directory: +If Orbiter's configuration is deployed to a different location, call Voyager with the -d or --directory flag and specify Orbiter's custom directory (**this is because you must use the Orbiter keystore to execute one of the following actions.**): ```sh -voyager auth add -f -voyager auth list -f -voyager auth remove -f +voyager auth add -d /custom/voyager/path +voyager auth list -d /custom/voyager/path +voyager auth remove -d /custom/voyager/path ``` +**You can retrieve the from OrbitDB's identity publicKey field.** + ## Pinning databases using "Lander" To make databases accessible from Voyager, the database needs to be pinned to an Orbiter instance. This can be achieved programmatically by using the "Lander" module.