wso2 / wso2/docs-apim

To improve the documentation for the internal keystore configuration in deployment.toml

Open
#8,116 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description:
In the documentation [1], Configuring WSO2 Identity Server as a Key Manager, there is no any details regarding the key store configuration, which will cause to mistakens (related to primary, secondary and internal key stores). Therefore if we add another steps by pointing [2] in [1] is much helpful in the terms of understanding.

  1. https://apim.docs.wso2.com/en/latest/InstallAndSetup/DeployingWSO2APIManager/DistributedDeployment/configuring-wso2-identity-server-as-a-key-manager/
  2. https://apim.docs.wso2.com/en/latest/Administer/ProductSecurity/ConfiguringKeystores/configuring-keystores-in-wso2-api-manager/

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the “Configuring WSO2 Identity Server as a Key Manager” documentation page and compare it with the linked “Configuring Keystores in WSO2 API Manager” page. Add guidance for the primary, secondary, and internal keystore settings in deployment.toml, with the keystore documentation linked for details; done means the deployment instructions no longer leave these configurations ambiguous.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, security
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.