Skip to content

Commit

Permalink
Update the readmes and release notes for the different distributions
Browse files Browse the repository at this point in the history
  • Loading branch information
Tharika Madurapperuma committed Feb 7, 2025
1 parent 79df55f commit afcf32b
Show file tree
Hide file tree
Showing 12 changed files with 137 additions and 805 deletions.
25 changes: 10 additions & 15 deletions api-control-plane/INSTALL.txt
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
Installing WSO2 API Manager (APIM)
Installing WSO2 API Control Plane (ACP)
=================================


Running WSO2 API Manager in standalone mode
Running WSO2 API Control Plane
===========================================
1. The directory containing this INSTALL.txt file will be the root and it will be
treated as Carbon home directory and let it be <APIM_HOME>.
treated as Carbon home directory and let it be <ACP_HOME>.

2. All the shell scripts and .bat files are available in <APIM_HOME>/bin folder.
2. All the shell scripts and .bat files are available in <ACP_HOME>/bin folder.

3. To start WSO2 APIM one can use either api-manager.sh or daemon.sh in all Unix
systems & api-manager.bat file on Windows operating systems.
3. To start WSO2 ACP one can use either api-cp.sh in all Unix
systems & api-cp.bat file on Windows operating systems.

4. Either of the following commands can be used to start APIM
i) ./api-manager.sh {console|start|stop|restart|version}
ii) api-manager.bat {start|stop|version}
i) ./api-cp.sh {console|start|stop|restart|version}
ii) api-cp.bat {start|stop|version}

Usage: api-manager.sh [command] [options] [system-properties]
Usage: api-cp.sh [command] [options] [system-properties]

command:
--start Start APIM as a Unix daemon in the background
Expand Down Expand Up @@ -48,9 +48,6 @@ Running WSO2 API Manager in standalone mode
Start Carbon with OSGi debugging enabled.
If the optional 'options-file is provided, the
OSGi debug options will be loaded from it.
-Dsetup Clean the Registry database & other
configuration, recreate DB, re-populate the
configuration, and start Carbon
-Dcarbon.registry.root
The root of the Registry used by
this Carbon instance
Expand Down Expand Up @@ -81,9 +78,7 @@ System Requirements
with MS IE 7. In addition to JavaScript, ActiveX should also be enabled
with IE. This can be achieved by setting your security level to
medium or lower.
5. To compile and run the sample clients in <APIM_HOME>/samples, an Ant version is required. Ant 1.7.0
version is recommended
6. To build WSO2 APIM from the Source distribution, it is necessary that you have
5. To build WSO2 APIM from the Source distribution, it is necessary that you have
JDK 11 version and Maven 3.0.4 or later

For more details see
Expand Down
35 changes: 11 additions & 24 deletions api-control-plane/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WSO2 API Manager
# WSO2 API Control Plane

---
Expand All @@ -11,32 +11,29 @@

---

WSO2 API Manager (WSO2 API-M) is a powerful platform for creating, managing, consuming, and
WSO2 API Control Plane (WSO2 ACP) is a powerful platform for creating, managing, consuming, and
monitoring web APIs. It combines tried and tested SOA best practices with modern
day API management principles to solve a wide range of enterprise challenges
associated with API provisioning, governance, and integration.

WSO2 API Manager consists of several loosely coupled modules.
WSO2 API Control Plane consists of several loosely coupled modules.

* API Publisher
* API Developer Portal
* API Gateway
* Admin Portal
* API Key Manager
* API Traffic Manager


The API publisher module allows API publishers to easily define APIs and manage them
using a strong governance model that consists of well-established concepts such as,
versioning and lifecycles. API consumers can use the API Developer Portal to discover
published, production-ready APIs and access them in a secure and reliable manner
using unique API keys. The built-in API Gateway module provides powerful tools to
secure and control the load on individual APIs.
using unique API keys.

WSO2 API Manager is based on the revolutionary WSO2 Carbon [Middleware a' la carte]
WSO2 API Control Plane is based on the revolutionary WSO2 Carbon [Middleware a' la carte]
framework. All the major features have been developed as reusable Carbon
components.

To learn more about WSO2 API Manager please visit http://wso2.com/products/api-manager.
To learn more about WSO2 API Control Plane please visit http://wso2.com/products/api-manager.

Key Features
=============
Expand Down Expand Up @@ -134,7 +131,6 @@ Key Features
- View metrics by user, API, and more.
- Customized reporting via plugging reporting engines.
- Monitor SLA compliance.
- Powered by WSO2 Data Analytics Server (WSO2 DAS).
</details>

<details>
Expand Down Expand Up @@ -177,13 +173,6 @@ Key Features
- OAuth2 authorization code grant type support.
- Configuring execution point of mediation extensions.
</details>

<details>
<summary>Monitor API Usage and Performance</summary>
- Improved dashboard for monitoring usage statistics (Filtering data for a date range, More visually appealing widgets).

</details>


System Requirements
Expand All @@ -196,17 +185,15 @@ System Requirements
with MS IE 7. In addition to JavaScript, ActiveX should also be enabled
with IE. This can be achieved by setting your security level to
medium or lower.
5. Apache Ant is required to compile and run the sample clients. Apache Ant 1.7.0
version is recommended.
6. To build WSO2 API Manager from the source distribution, it is necessary that you have
5. To build WSO2 API Manager from the source distribution, it is necessary that you have
JDK 11 and Maven 3.0.4 or later.

Installation & Running
==================================

1. Extract the wso2am-4.5.0.zip and go to the 'bin' directory
2. Run the api-manager.sh or api-manager.bat script based on you operating system.
3. Access the respective WSO2 API-M interfaces
1. Extract the wso2am-acp-4.5.0.zip and go to the 'bin' directory
2. Run the api-cp.sh or api-cp.bat script based on you operating system.
3. Access the respective WSO2 ACP interfaces
* API Publisher web application is running at - https://localhost:9443/publisher \
You may sign in to the Publisher using the default administrator credentials (username: admin, password: admin).
* Developer Portal web application is running at - https://localhost:9443/devportal \
Expand Down
33 changes: 14 additions & 19 deletions api-control-plane/README.txt
Original file line number Diff line number Diff line change
@@ -1,32 +1,30 @@
================================================================================
WSO2 API Manager
WSO2 API Control Plane
================================================================================

WSO2 API Manager (WSO2 API-M) is a powerful platform for creating, managing, consuming,
WSO2 API Control Plane (WSO2 ACP) is a powerful platform for creating, managing, consuming,
and monitoring web APIs. It combines tried and tested SOA best practices with modern
day API management principles to solve a wide range of enterprise challenges associated
with API provisioning, governance, and integration.

WSO2 API Manager consists of several loosely coupled modules.
WSO2 API Control Plane consists of several loosely coupled modules.

* API publisher
* API Publisher
* API Developer Portal
* API gateway
* Admin Portal
* API Key Manager
* API Traffic Manager

The API publisher module allows API publishers to easily define APIs and manage them
using a strong governance model that consists of well-established concepts such as,
versioning and lifecycles. API consumers can use the API Developer Portal module to discover
published, production-ready APIs and access them in a secure and reliable manner
using unique API keys. The built-in API Gateway module provides powerful tools to
secure and control the load on individual APIs.
using unique API keys.

WSO2 API Manager is based on the revolutionary WSO2 Carbon [Middleware a' la carte]
WSO2 API Control Plane is based on the revolutionary WSO2 Carbon [Middleware a' la carte]
framework. All the major features have been developed as reusable Carbon
components.

To learn more about WSO2 API Manager please visit http://wso2.com/products/api-manager.
To learn more about WSO2 API Control Plane please visit http://wso2.com/products/api-manager.

Key Features
=============
Expand Down Expand Up @@ -109,8 +107,7 @@ Key Features
- View metrics by user, API, and more.
- Customized reporting via plugging reporting engines.
- Monitor SLA compliance.
- Powered by WSO2 Data Analytics Server (WSO2 DAS).


* Pluggable, Extensible and Themeable:
- All components are highly customizable through styling, theming, and open source code.
- Developer Portal implemented with React.
Expand Down Expand Up @@ -160,17 +157,15 @@ System Requirements
with MS IE 7. In addition to JavaScript, ActiveX should also be enabled
with IE. This can be achieved by setting your security level to
medium or lower.
5. Apache Ant is required to compile and run the sample clients. Apache Ant 1.7.0
is recommended.
6. To build WSO2 API Manager from the Source distribution, it is necessary that you have
5. To build WSO2 API Control Plane from the Source distribution, it is necessary that you have
JDK 11 version and Maven 3.0.4 or later

Installation & Running
==================================

1. Extract the wso2am-4.5.0.zip and go to the 'bin' directory
2. Run the api-manager.sh or api-manager.bat script based on you operating system.
3. Access the respective WSO2 API-M interfaces
1. Extract the wso2am-acp-4.5.0.zip and go to the 'bin' directory
2. Run the api-cp.sh or api-cp.bat script based on you operating system.
3. Access the respective WSO2 ACP interfaces
* API Publisher web application is running at - https://localhost:9443/publisher
You may sign in to the Publisher using the default administrator credentials
(username: admin, password: admin).
Expand All @@ -182,7 +177,7 @@ Documentation
==============

Online product documentation is available at:
https://apim.docs.wso2.com/en/4.3.0/
https://apim.docs.wso2.com/en/latest/

Support
==================================
Expand Down
20 changes: 7 additions & 13 deletions api-control-plane/release-notes.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta content="text/html; charset=iso-8859-1" http-equiv="content-type"/>
<title>WSO2 API Manager v4.4.0 - 30th October 2024</title>
<title>WSO2 API Control Plane v4.5.0 - March 2025</title>
</head>
<body>
<div id="main-content">
<h1>WSO2 API Manager 4.4.0 Released!</h1>
<h1>WSO2 API Control Plane 4.5.0 Released!</h1>

<p>
The WSO2 API Manager team is pleased to announce the release of version 4.4.0 of
the Open Source API Manager.
The WSO2 API Manager team is pleased to announce the release of version 4.5.0 of
the Open Source API Control Plane.
</p>

<p>
Expand All @@ -45,30 +45,24 @@ <h1>WSO2 API Manager 4.4.0 Released!</h1>
allows API product managers to manage the lifecycle of APIs and create API products by using one or more APIs.</li><br/>
<li><b>Developer Portal:</b> A portal for onboarding application creators. It allows application creators to discover, <br/>
subscribe, test and consume APIs through their applications.</li><br/>
<li><b>API Gateway:</b> Allows access to APIs/services by routing application traffic to the relevant endpoints. <br/>
The API Gateway is the component that enforces security, rate-limiting and transformations on API requests while <br/>
feeding valuable information of these requests to API Analytics.</li><br/>
<li><b>Key Manager:</b> The security token service of the API Manager which is responsible for handling everything <br/>
related to authentication and authorization of API requests. It supports a wide variety of security protocols such <br/>
as OAuth2.0/OIDC, Basic Auth, API Key, SAML based single-sign-on.</li><br/>
<li><b>Traffic Manager:</b> Controls the traffic flow of the API gateway. This is used to apply request quotas on APIs <br/>
for monetization, access control or security related matters. In addition to configuring the available policies, users <br/>
can deploy their own policies on the traffic manager which will control the rate of traffic on the API gateways.</li><br/>
<li><b>API Analytics:</b> Monitors all traffic that’s routed through the API gateways to analyse usage patterns, <br/>
SLA violations, consumer behaviours, to provide business insights and so on.</li>
</ul>

<p>
For more information on WSO2 API Manager please visit <a href="https://wso2.com/api-management/">
https://wso2.com/api-management/</a>. Also take a look at the online product
<a href="https://apim.docs.wso2.com/en/4.4.0/">documentation</a>.
<a href="https://apim.docs.wso2.com/en/latest/">documentation</a>.
</p>

<h2>How to Run</h2>
<ol>
<li>Extract the downloaded zip</li>
<li>Go to the bin directory in the extracted folder</li>
<li>Run the api-manager.sh or api-manager.bat as appropriate</li>
<li>Run the api-cp.sh or api-cp.bat as appropriate</li>
<li>Launch a web browser and navigate to <a href="https://localhost:9443/publisher">https://localhost:9443/publisher</a>
to access the API provider webapp
</li>
Expand All @@ -77,7 +71,7 @@ <h2>How to Run</h2>
<li>Use "admin", "admin" as the username and password to login as an admin</li>
</ol>

<h2>Bug Fixes And Improvements in 4.4.0</h2>
<h2>Bug Fixes And Improvements in 4.5.0</h2>
<ul>
<li>GitHub (<a href="https://github.com/wso2/api-manager/issues?q=is%3Aissue+is%3Aclosed+label%3AComponent%2FAPIM+closed%3A2024-04-10..2024-10-30+">api-manager</a>)
</li>
Expand Down
30 changes: 12 additions & 18 deletions gateway/INSTALL.txt
Original file line number Diff line number Diff line change
@@ -1,31 +1,30 @@
Installing WSO2 API Manager (APIM)
Installing WSO2 API Gateway (API-GW)
=================================


Running WSO2 API Manager in standalone mode
Running WSO2 API Gateway
===========================================
1. The directory containing this INSTALL.txt file will be the root and it will be
treated as Carbon home directory and let it be <APIM_HOME>.
treated as Carbon home directory and let it be <API_GW_HOME>.

2. All the shell scripts and .bat files are available in <APIM_HOME>/bin folder.
2. All the shell scripts and .bat files are available in <API_GW_HOME>/bin folder.

3. To start WSO2 APIM one can use either api-manager.sh or daemon.sh in all Unix
systems & api-manager.bat file on Windows operating systems.
3. To start WSO2 API-GW one can use either api-gateway.sh in all Unix
systems & api-gateway.bat file on Windows operating systems.

4. Either of the following commands can be used to start APIM
i) ./api-manager.sh {console|start|stop|restart|version}
ii) api-manager.bat {start|stop|version}
4. Either of the following commands can be used to start API-GW
i) ./api-gateway.sh {console|start|stop|restart|version}
ii) api-gateway.bat {start|stop|version}

Usage: api-manager.sh [command] [options] [system-properties]
Usage: api-gateway.sh [command] [options] [system-properties]

command:
--start Start APIM as a Unix daemon in the background
--console Start APIM as a Unix daemon in the foreground
--stop Stop the APIM Unix daemon
--restart Restart the APIM Unix daemon
--version What version of the APIM server are you running
--optimize Start APIM with specific features of the profile


options:
--debug <port> Start the server in remote debugging mode.
port: The remote debugging port.
Expand All @@ -48,9 +47,6 @@ Running WSO2 API Manager in standalone mode
Start Carbon with OSGi debugging enabled.
If the optional 'options-file is provided, the
OSGi debug options will be loaded from it.
-Dsetup Clean the Registry database & other
configuration, recreate DB, re-populate the
configuration, and start Carbon
-Dcarbon.registry.root
The root of the Registry used by
this Carbon instance
Expand Down Expand Up @@ -81,9 +77,7 @@ System Requirements
with MS IE 7. In addition to JavaScript, ActiveX should also be enabled
with IE. This can be achieved by setting your security level to
medium or lower.
5. To compile and run the sample clients in <APIM_HOME>/samples, an Ant version is required. Ant 1.7.0
version is recommended
6. To build WSO2 APIM from the Source distribution, it is necessary that you have
5. To build WSO2 API-GW from the Source distribution, it is necessary that you have
JDK 11 version and Maven 3.0.4 or later

For more details see
Expand Down
Loading

0 comments on commit afcf32b

Please sign in to comment.