Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance VCkit API Documentation for Database Encryption Key Configuration #227

Open
7 tasks
ashleythedeveloper opened this issue Nov 17, 2024 · 0 comments
Open
7 tasks
Labels
docs Improvements or additions to documentation

Comments

@ashleythedeveloper
Copy link
Contributor

As a VCkit maintainer,
I want to add information about database encryption key configuration to the VCkit API documentation,
So that implementers can properly understand and configure the database encryption key for the VCkit API server.

Acceptance Criteria:

  • Add a new section in the API server installation documentation specifically about database encryption keys
  • Document the purpose of the dbEncryptionKey configuration
  • Include details about the key type (X25519)
  • Add instructions for generating a new encryption key using the veramo config gen-key command
  • Include example configuration showing proper key usage in agent.yml
  • Add warning about not using the example key in production environments
  • Review and validate documentation accuracy with the core maintainers
@ashleythedeveloper ashleythedeveloper added the docs Improvements or additions to documentation label Nov 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant