Document the openssl dependency, the Proof-of-Knowledge authentication #88
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also document the automatic creation of the database if it does not exist.
|
👋 Thanks for assigning @tnull as a reviewer! |
Contributor
Author
|
Fixes #77 |
tnull
reviewed
Jan 23, 2026
|
|
||
| - Install Rust and Cargo (https://www.rust-lang.org/tools/install). | ||
| - Install PostgreSQL 15 (https://www.postgresql.org/download/) | ||
| - Install openssl (used for TLS connections to the postgres backend: https://docs.rs/openssl/latest/openssl/#automatic) |
Contributor
There was a problem hiding this comment.
Suggested change
| - Install openssl (used for TLS connections to the postgres backend: https://docs.rs/openssl/latest/openssl/#automatic) | |
| - Install OpenSSL (used for TLS connections to the PostgreSQL backend: https://docs.rs/openssl/latest/openssl/#automatic) |
| environment variables as needed. Add PostgreSQL endpoint configuration. | ||
| 2. Create table in PostgreSQL using `./impls/src/postgres/sql/` | ||
| environment variables as needed. | ||
| 2. VSS will setup a Postgres database on first launch if it is not found. You can also manually create the database |
Contributor
There was a problem hiding this comment.
Suggested change
| 2. VSS will setup a Postgres database on first launch if it is not found. You can also manually create the database | |
| 2. VSS will setup a PostgreSQL database on first launch if it is not found. You can also manually create the database |
| without authentication for local testing or in trusted setups. The VSS-rust-client supports LNURL-auth & JWT based | ||
| authentication and authorization. Switching to simple HTTP header authentication is straightforward by adding another | ||
| implementation. Note that the security of authentication heavily relies on using HTTPS for all requests. | ||
| * **Authentication and Authorization**: Currently, the VSS-server supports authentication via Proof-of-Knowledge |
Contributor
There was a problem hiding this comment.
Proof-of-Knowledge of what? Two-three more words might help here. Also maybe link to the new section below?
| authentication and authorization. Switching to simple HTTP header authentication is straightforward by adding another | ||
| implementation. Note that the security of authentication heavily relies on using HTTPS for all requests. | ||
| * **Authentication and Authorization**: Currently, the VSS-server supports authentication via Proof-of-Knowledge | ||
| or [JWT](https://datatracker.ietf.org/doc/html/rfc7519). The API also offers hooks for simple HTTP header |
Contributor
There was a problem hiding this comment.
Suggested change
| or [JWT](https://datatracker.ietf.org/doc/html/rfc7519). The API also offers hooks for simple HTTP header | |
| or [JWT](https://datatracker.ietf.org/doc/html/rfc7519). The API also offers hooks for simple HTTP header-based |
Contributor
There was a problem hiding this comment.
If we describe these rust-only changes in the global README, maybe we should consider to remove the java version soonish? What's our current thinking around timeline for that?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also document the automatic creation of the database if it does not exist.