Config properties referenced on page but not included in config catalog
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
Description:
On the 'Security Guidelines for a Production Deployment' page in the section 'Configure strong HTTP(S) security' a configuration setting is mentioned that is not reflected in the 'API-M Config Catalog'.
Suggested Labels:
API-M 4.10,Docs/API-Security
Affected Product Version:
4.1
Steps to reproduce:
Follow Security Guidelines for a Production Deployment page.
This can be done by replacing the sslProtocol = "TLS" property with sslEnabledProtocols="TLSv1,TLSv1.1,TLSv1.2" under [transport.https.sslHostConfig .properties] in the deployment.toml file.
Try to lookup this [transport.https.sslHostConfig.properties] in the Config Catalog: https://apim.docs.wso2.com/en/latest/reference/config-catalog/. It is not mentioned there.
Related Issues:
[transport.https.sslHostConfig .properties]
Note the extra space between sslHostConfig en .properties.
In addition, configure strong ciphers for ThriftAuthenticationService, Tomcat transport, and PassThrough transport in the deployment.toml file
No link to docs page for ThriftAuthenticationService.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the Security Guidelines for a Production Deployment page and the API-M Config Catalog, then compare the referenced transport.https.sslHostConfig.properties settings with the catalog entries. Check the deployment.toml references and the ThriftAuthenticationService, Tomcat transport, and PassThrough transport documentation links; done means the mentioned configuration is cataloged and the relevant documentation links are present.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100