docs: bring README.md in line with Standard Readme
This commit is contained in:
parent
c8825ff377
commit
f356d8a237
1 changed files with 32 additions and 1 deletions
33
README.md
33
README.md
|
|
@ -1,6 +1,8 @@
|
||||||
# verae-nats-cluster
|
# verae-nats-cluster
|
||||||
|
|
||||||
Three **distinct Proxmox LXC** guests running **NATS JetStream** as a cluster, on the private bridge only. This is the test stand before the same layout moves to separate hardware.
|
[](https://github.com/RichardLitt/standard-readme)
|
||||||
|
|
||||||
|
Three **distinct Proxmox LXC** guests running **NATS JetStream** as a cluster, on the private bridge only. This is...
|
||||||
|
|
||||||
**Forgejo:** https://git.georgelambert.org/marchon/verae-nats-cluster
|
**Forgejo:** https://git.georgelambert.org/marchon/verae-nats-cluster
|
||||||
**SSH:** `ssh://git@git.georgelambert.org:2223/marchon/verae-nats-cluster.git`
|
**SSH:** `ssh://git@git.georgelambert.org:2223/marchon/verae-nats-cluster.git`
|
||||||
|
|
@ -74,3 +76,32 @@ Latest run (`20260912T045131Z`):
|
||||||
| Flood 8p 20k×128 B | burst queueing | avg 454 ms |
|
| Flood 8p 20k×128 B | burst queueing | avg 454 ms |
|
||||||
|
|
||||||
Hardware move: same three configs, three boxes, private NIC only — change IPs in `cluster.env` and `conf/nats.conf.tmpl`.
|
Hardware move: same three configs, three boxes, private NIC only — change IPs in `cluster.env` and `conf/nats.conf.tmpl`.
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [Install](#install)
|
||||||
|
- [Usage](#usage)
|
||||||
|
- [Contributing](#contributing)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone ssh://git@git.georgelambert.org:2223/marchon/verae-nats-cluster.git
|
||||||
|
cd verae-nats-cluster
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# No single entrypoint is declared in this tree.
|
||||||
|
ls
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Questions: open an issue at https://git.georgelambert.org/marchon/verae-nats-cluster/issues. Pull requests are accepted.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
UNLICENSED © George Lambert
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue