wso2 / wso2/docs-apim

All in one docs missing the configurations on enabling secure broker connection

Open
#9,823 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description

In the all in one docs[1] we do not have configuration guide where customers can use to enable secure broker connection.

In our distributed docs [2] we have the required configurations.

[1] https://apim.docs.wso2.com/en/4.4.0/install-and-setup/setup/single-node/all-in-one-deployment-overview/
[2] https://apim.docs.wso2.com/en/4.4.0/install-and-setup/setup/distributed-deployment/deploying-wso2-api-m-in-a-distributed-setup/

Suggested Improvement

Add the required configurations on the All in one docs.

Also it would be good to refer those docs in the security best practices docs[2]

[3] https://apim.docs.wso2.com/en/4.4.0/install-and-setup/setup/deployment-best-practices/security-guidelines-for-production-deployment/#runtime-level-security

Version(s)

All

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

Compare the distributed deployment documentation linked in the issue with the all-in-one deployment page to identify the required secure broker connection configurations. Update the all-in-one guide and add the relevant reference to the runtime-level security section of the security best practices page; done means both pages cover or link to the required guidance.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.