Skip to content

README.md

Latest commit

 

History

History
44 lines (31 loc) · 1.42 KB

README.md

File metadata and controls

44 lines (31 loc) · 1.42 KB

Versioned Storage Service (Rust)

This directory hosts the Rust-based implementation of the Versioned Storage Service (VSS).

Prerequisites

Building

git clone https://github.com/lightningdevkit/vss-server.git
cd vss-server/rust

cargo build --release

Running

  1. Edit Configuration: Modify ./server/vss-server-config.toml to set application configuration and environment variables as needed. Add PostgreSQL endpoint configuration.

  2. Create table in PostgreSQL using ./impls/src/postgres/sql/

  3. Start server:

    cargo run -- server/vss-server-config.toml

    Note: For testing purposes, you can pass --in-memory to use in-memory instead of PostgreSQL

    cargo run -- server/vss-server-config.toml --in-memory

  4. VSS endpoint should be reachable at http://localhost:8080/vss.

Configuration

Refer to ./server/vss-server-config.toml to see available configuration options.

Support

If you encounter any issues or have questions, feel free to open an issue on the GitHub repository. For further assistance or to discuss the development of VSS, you can reach out to us in the LDK Discord in the #vss channel.