Skip to content

Commit

Permalink
docs: Update installation docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
haydenyoung committed Nov 16, 2024
1 parent 49d0f3e commit 54cc6b7
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Voyager, like OrbitDB, does not have a traditional server/client architecture an
npm i @orbitdb/voyager
```

## Running "Orbiter"
### Running "Orbiter"

Voyager's Orbiter (the pinning service) can be run as a daemon process. You can install the package globally and run it using the "voyager" binary:

Expand All @@ -29,6 +29,19 @@ To store Orbiter's configuration to a different location, use the -d or --direct
voyager daemon -d /path/to/voyager
```

### Docker

You can run an Orbiter pinning service using a pre-configured Docker image.

Once you have cloned this repo, cd into the voyager directory root and run:

```
docker build -t orbitdb-pinner ./
docker run --rm -d -p 8000:8000 orbitdb-pinner
```

Adjust the port if required.

## Managing "Orbiter" access

Access to Orbiter can be configured using the Voyager binary.
Expand Down

0 comments on commit 54cc6b7

Please sign in to comment.