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

Remove hardcoded API Key from sample agent.template.yml #203

Closed
jballment opened this issue Jul 23, 2024 · 0 comments
Closed

Remove hardcoded API Key from sample agent.template.yml #203

jballment opened this issue Jul 23, 2024 · 0 comments

Comments

@jballment
Copy link
Contributor

Note: please read the RFC contributing guide before proposing a new feature here

Is your feature request related to a problem? Please describe.
When building project-vckit via Docker, I've noticed the packages/cli/default/agent.template.yml file has a hardcode API Key value. This is hard to find and undocumented as a default value.

Describe the solution you'd like
Recommend adding the API Key to local.env file and parameterising within the agent.template.yml file and updating entrypoint.sh to build agent.yml from agent.template.yml including the new parameter.

Describe alternatives you've considered
I've considered just updating the documentation, but I think it makes the Docker build more useful if these parameters are controlled correctly.
jballment added a commit to jballment/project-vckit that referenced this issue Jul 23, 2024
@jballment
parameterised API Key for Docker builds (uncefact#203)
10a7bf7
jballment added a commit to jballment/project-vckit that referenced this issue Jul 23, 2024
@jballment
parameterised API Key for Docker builds (uncefact#203)
b670b87
@jballment jballment mentioned this issue Jul 23, 2024
Merged
15 tasks
namhoang1604 pushed a commit that referenced this issue Jul 24, 2024
@jballment
parameterised API Key for Docker builds (#203) (#204)
9bb0a2c 
## What type of PR is this? (check all applicable)

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

## Description

Parameterised API Key for Docker builds

## Related Tickets & Documents

#203 and updated README.md

## Mobile & Desktop Screenshots/Recordings

N/A

## Added tests?

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

## Added to documentation?

- [ X ] 📜 README.md
- [ ] 📓 [vc-kit doc site](https://uncefact.github.io/vckit/)
- [ ] 📕 storybook
- [ ] 🙅 no documentation needed
namhoang1604 added a commit that referenced this issue Sep 19, 2024
@namhoang1604
Merge branch 'next' of github.com:uncefact/project-vckit into chore/m…
430c891 
…erge-next-to-main

* 'next' of github.com:uncefact/project-vckit: (90 commits)
  feat: enveloping proof (#207)
  feat: Add `eddsa-rdfc-2022-cryptosuite` Plugin (#200)
  chore: update bitstring status package (#211)
  docs: update identifier creation (#208)
  feat(cd): ghcr.io setup and docker image build workflow (#206)
  changed Dockerfile to use default agent.template.yml (#201) (#205)
  parameterised API Key for Docker builds (#203) (#204)
  feat: setup package workflow
  feat: create git workflow for release tagging and generate the release note (#199)
  fix: Provide meaningful error message when signature verification fails (#197)
  docs: add documentation site (#198)
  feat: implement renderer 2024 provider (#177)
  chore: update arguments and envs for the Dockerfile (#194)
  fix: using revocation list on explorer and handle no hash (#192)
  docs: add yarn to prerequisites
  chore: change node version to 20.12.2 (#187)
  chore: update default agent for Status plugin (#186)
  chore: fix the dockerfile to set entrypoint
  chore: update vckit Dockerfile (#184)
  chore: update DockerFile and agent template (#183)
  ...

Signed-off-by: Nam Hoang <hoangxuannam160493@gmail.com>

# Conflicts:
#	.github/workflows/build-test-publish.yml
#	.github/workflows/deploy-to-s3.yml
#	jest.config.mjs
#	package.json
#	packages/core-types/package.json
#	packages/credential-oa/__tests__/action-handler.test.ts
#	packages/credential-oa/src/action-handler.ts
#	pnpm-lock.yaml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jballment @namhoang1604