Skip to content

Commit

Permalink
Update docs: add version
Browse files Browse the repository at this point in the history
  • Loading branch information
gagliardetto committed Jan 28, 2024
1 parent 056fe16 commit ff81ac5
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ To run a Faithful RPC server you need to specify configuration files for the epo

```yml
epoch: 0 # epoch number (required)
version: 1 # version number (required)
data: # data section (required)
car:
# Source the data from a CAR file (car-mode).
Expand Down
6 changes: 4 additions & 2 deletions site/production-server.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,14 @@ The production server is available via the `faithful-cli rpc` command.

To run a Faithful RPC server you need to specify configuration files for the epoch(s) you want to host. For multi-epoch support you need to generate epoch config files for the epochs that you want to host. An epoch config file looks like this:

```
```yml
data:
car:
uri: /faithful/493/epoch-493.car
filecoin:
enable: false
epoch: 493
version: 1
indexes:
cid_to_offset:
uri: /faithful/493/epoch-493.car.bafyreidlbcsg46dn5mqppioijyqb5cn6j23rkcoazl7skif74kpa3lihxa.cid-to-offset.index
Expand All @@ -38,12 +39,13 @@ The `uri` parameter supports both HTTP URIs as well as file based ones.

If you want you can also run the RPC server using some (or all) epochs via Filecoin:

```
```yml
data:
filecoin:
enable: true
root_cid: bafyreigq7w4bwspbsf7j4ykov34fcf6skrn663n4ywfalgxlhp7o5nes5a
epoch: 494
version: 1
indexes:
cid_to_offset:
uri: /faithful/494/epoch-494.car.bafyreigq7w4bwspbsf7j4ykov34fcf6skrn663n4ywfalgxlhp7o5nes5a.cid-to-offset.index
Expand Down

0 comments on commit ff81ac5

Please sign in to comment.