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.

Sign up for GitHub

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

Jump to bottom

Enhance VCkit API Documentation for Database Encryption Key Configuration #227

Open
7 tasks done
ashleythedeveloper opened this issue Nov 17, 2024 · 0 comments
Open
7 tasks done

Enhance VCkit API Documentation for Database Encryption Key Configuration #227

ashleythedeveloper opened this issue Nov 17, 2024 · 0 comments
Assignees
@ldhyen99
Labels
docs Improvements or additions to documentation

Comments

@ashleythedeveloper
Copy link
Contributor

ashleythedeveloper commented Nov 17, 2024 •
edited by ldhyen99
Loading

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
@ldhyen99 ldhyen99 self-assigned this Nov 29, 2024
@ldhyen99 ldhyen99 mentioned this issue Dec 2, 2024
Merged
18 tasks
ldhyen99 added a commit that referenced this issue Dec 3, 2024
@ldhyen99
docs: add new section in document about db encryption key (#230)
ffc5001 
…tion key

<!--
  For Work In Progress Pull Requests, please use the Draft PR feature,
see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for
further details.
  
  For a timely review/response, please avoid force-pushing additional
  commits if your PR already received reviews or comments.
  
Before submitting a Pull Request, please ensure you've done the
following:
- 📖 Read the [Contributing
Guide](https://github.com/uncefact/project-vckit/blob/main/CONTRIBUTING.md).
- 📖 Read the [Code of
Conduct](https://github.com/uncefact/project-vckit/blob/main/CODE_OF_CONDUCT.md).
  - 👷‍♀️ Create small PRs. In most cases, this will be possible.
  - ✅ Provide tests for your changes.
- 📝 Use descriptive commit messages following [conventional
commits](https://www.conventionalcommits.org/en/v1.0.0/).
- 📗 Update any related documentation and include any relevant
screenshots.
-->

## What type of PR is this? (check all applicable)

- [ ] 🍕 Feature
- [ ] 🐛 Bug Fix
- [x] 📝 Documentation Update
- [ ] 🎨 Style
- [ ] 🧑‍💻 Code Refactor
- [ ] 🔥 Performance Improvements
- [ ] ✅ Test
- [ ] 🤖 Build
- [ ] 🔁 CI
- [ ] 📦 Chore (Release)
- [ ] ⏩ Revert

## Description

<!-- 
Please do not leave this blank 
This PR [adds/removes/fixes/replaces] the [feature/bug/etc]. 
-->

## Related Tickets & Documents
<!-- 
Please use this format link issue numbers: Fixes #123

https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
-->
#227
## Mobile & Desktop Screenshots/Recordings

<!-- Visual changes require screenshots -->


## Added tests?

- [ ] 👍 yes
- [x] 🙅 no, because they aren't needed
- [ ] 🙋 no, because I need help

## Added to documentation?

- [ ] 📜 README.md
- [ ] 📓 [vc-kit doc site](https://uncefact.github.io/vckit/)
- [ ] 📕 storybook
- [x] 🙅 no documentation needed

## [optional] Are there any post-deployment tasks we need to perform?


<!-- note: PRs with deleted sections will be marked invalid -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ldhyen99 ldhyen99

Labels
docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ldhyen99 @ashleythedeveloper