Skip to content

Commit ed949e2

Browse files
committed
Add README for Rust-based VSS implementation.
1 parent 59e0d58 commit ed949e2

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

rust/README.md

+38-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,38 @@
1-
## WIP
2-
Not ready for use !!
1+
# Versioned Storage Service (Rust)
2+
3+
This directory hosts the Rust-based implementation of the Versioned Storage Service (VSS).
4+
5+
### Prerequisites
6+
7+
- Install Rust and Cargo (https://www.rust-lang.org/tools/install).
8+
- Install PostgreSQL 15 (https://www.postgresql.org/download/)
9+
10+
### Building
11+
12+
```
13+
git clone https://github.com/lightningdevkit/vss-server.git
14+
cd vss-server/rust
15+
16+
cargo build --release
17+
```
18+
19+
### Running
20+
1. **Edit Configuration**: Modify `./vss_server_config.toml` to set application configuration and
21+
environment variables as needed. Add PostgreSQL endpoint configuration.
22+
2. Start server:
23+
```
24+
cargo run -- vss-server-config.toml
25+
```
26+
3. VSS endpoint should be reachable at `http://localhost:8080/vss`.
27+
28+
### Configuration
29+
30+
Refer `./vss_server_config.toml` to see available configuration options.
31+
32+
### Support
33+
34+
If you encounter any issues or have questions, feel free to open an issue on
35+
the [GitHub repository](https://github.com/lightningdevkit/vss-server/issues). For further assistance or to discuss the
36+
development of VSS, you can reach out to us in the [LDK Discord](https://discord.gg/5AcknnMfBw) in the `#vss` channel.
37+
38+
[LDK Discord]: https://discord.gg/5AcknnMfBw

0 commit comments

Comments
 (0)