wso2 / wso2/docs-apim

Custom URL documentation is out of date

Open
#5,329 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API-M-4.1.0 help wanted Priority/High Severity/Major Type/Bug
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description:
There are out of sync information in the doc.

  1. Doc suggests adding a config to /_system/config/apimgt/applicationdata/tenant-conf.json. But this file is not available in the Registry now. This can be done on the admin portal now.
  2. The following also fails since my Nginx does not have the SSL certificates. This has to be explained how to generate the certs etc.
Navigate to the <API-M_HOME>/repository/resources/security directory and use the following command to add the Nginx certificate to the client trust store.

Copied to clipboard
keytool -import -file /etc/nginx/ssl/nginx.crt -keystore client-truststore.jks -storepass wso2carbon -alias wso2carbon2

https://apim.docs.wso2.com/en/latest/reference/customize-product/customizations/customize-the-api-store-and-gateway-urls-for-tenants/#configure-per-tenant-custom-domain-mappings

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 linked “Configure per-tenant custom domain mappings” section and verify the current admin portal workflow, since the referenced Registry file is unavailable. Check the Nginx SSL certificate and trust-store instructions, including how certificates are generated; the work is done when the documented steps match the current product and can be followed successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
nginx
Domain
documentation
Issue type
Documentation
Difficulty
2/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.