Skip to content

Commit

Permalink
Merge pull request #87 from arik-so/demo-server-docs
Browse files Browse the repository at this point in the history
Add demo server and timestamp usage documentation
  • Loading branch information
TheBlueMatt authored Jan 31, 2025
2 parents 497ebe5 + 1e008f2 commit 9144741
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,28 @@ 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.

Note that this is pretty much the same functionality you would need in a production environment, except hopefully using
something more robust than Python's `http.server` module.

## Modules

### config
Expand Down

0 comments on commit 9144741

Please sign in to comment.