Skip to content

Commit

Permalink
Add demo server and timestamp usage documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
arik-so committed Nov 21, 2024
1 parent 5d48711 commit c7792a4
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,25 @@ gossip data.

These are the components it's comprised of.

## Demo Server

To experiment with a local instance of the RGS server, navigate to the cache directory specified using
the `RAPID_GOSSIP_SYNC_SERVER_CACHES_PATH` environment variable (`./res` by default) and therein to the `symlinks`
subdirectory:

```
<cache_path>/symlinks
```

From there, simply run:

```shell
python3 -m http.server 8011
```

The snapshots will be accessible via `http://localhost:8011/{timestamp}.bin`. The first timestamp value should be 0,
and subsequent timestamps will be extracted from the snapshots themselves by the RGS client.

## Modules

### config
Expand Down

0 comments on commit c7792a4

Please sign in to comment.