wso2 / wso2/docs-apim

[Improvement] Configuring proxy profiles in WSO2 API Manager

Open
#10,177 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description

In APIM 4.1.0, the Proxy Configuration for token endpoint of secured backends feature is not available. A subsection needs to be added in the documentation[1] explaining how to configure proxy profiles in WSO2 API Manager globally.

[1] https://apim.docs.wso2.com/en/4.1.0/design/endpoints/endpoint-security/oauth-2.0/

Suggested Improvement

The following configuration should be added

[apim.proxy_config]
enable = true
host =  "127.0.0.1" 
port = "8080"
nonProxyHosts = "localhost|127.0.0.1|10.*.*.*|\\*.example.org"
protocol = "http"

targetProxyHosts = "[am.wso2.com](http://am.wso2.com/)" also can be added here. A note should be added as it will be available only from the U2 level 187.

Version(s)

4.x

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 OAuth 2.0 endpoint-security documentation at https://apim.docs.wso2.com/en/4.1.0/design/endpoints/endpoint-security/oauth-2.0/. Add a subsection explaining global proxy profile configuration using the supplied [apim.proxy_config] example, including targetProxyHosts and the U2 level 187 availability note. Done means the configuration guidance is present and the documentation renders correctly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.