@@ -88,7 +88,7 @@ Learn how API Gateways work with real-world examples and insights into Membrane.
88
88
- Streams HTTP traffic for low-latency, non-blocking processing.
89
89
- Reuses TCP connections via HTTP Keep-Alive to reduce request overhead.
90
90
- Lightweight distribution (~ 55MB) compared to other Java-based gateways.
91
- - Low memory footprint— ideal for containers and cloud-native environments.
91
+ - Low memory footprint, ideal for containers and cloud-native environments.
92
92
- Java-based, yet competitive with C/C++ gateways in performance.
93
93
94
94
# Content
@@ -135,53 +135,42 @@ Learn how API Gateways work with real-world examples and insights into Membrane.
135
135
- [ Monitoring with Prometheus and Grafana] ( #monitoring-with-prometheus-and-grafana )
136
136
- [ OpenTelemetry] ( #opentelemetry-integration )
137
137
138
- # Getting Started
138
+ # Installation
139
139
140
- ## Java
141
-
142
- ### Prerequisites
143
- - Ensure ** Java 21** or newer is installed.
140
+ You can run Membrane as Docker container, standalone Java application or install it on Linux as RPM.
144
141
145
- ### Setup and Run
146
- 1 . ** Download and Extract**
147
- - Get the latest [ binary release] ( https://github.com/membrane/api-gateway/releases ) and unzip it.
142
+ ## Java
148
143
144
+ 1 . ** Download and extract**
145
+ - [ Download a release] ( https://github.com/membrane/api-gateway/releases ) and unzip it.
149
146
2 . ** Start the Gateway**
150
- - Open a terminal in the extracted directory.
151
- - Run the appropriate command:
147
+ - Open a terminal in the extracted folder.
148
+ - Make sure Java 21 or newer is installed:
149
+ ``` bash
150
+ java -version
151
+ ```
152
+ - Start:
152
153
- ** Linux/Mac:** ` ./membrane.sh`
153
154
- ** Windows:** ` membrane.cmd`
155
+ 4. ** Access the Gateway**
156
+ - Open [http://localhost:2000](http://localhost:2000)
157
+ 5. ** Change the Configuration**
154
158
155
- 3 . ** Access the Gateway**
156
- - Open [ http://localhost:2000 ] ( http://localhost:2000 ) in your browser.
157
- - The gateway will forward traffic to [ https://api.predic8.de ] ( https://api.predic8.de ) by default.
158
-
159
- 4 . ** Modify Configuration**
160
- - Customize the behavior, by editing the file ` conf/proxies.xml ` .
161
-
159
+ Modify the preconfigured APIs or add APIs by editing the ` proxies.xml` file in the ` conf` folder.
162
160
163
161
# # Docker
164
162
165
- ### Quick Start
166
-
167
- 1 . ** Start the Gateway**
168
-
169
- Run Membrane in a container:
163
+ 1. ** Start a Membrane container**
170
164
` ` ` bash
171
165
docker run -p 2000:2000 predic8/membrane
172
- ```
173
-
166
+ ` ` `
174
167
2. ** Access the Gateway**
175
168
176
- Open [ http://localhost:2000 ] ( http://localhost:2000 ) in your browser, or use ` curl ` :
177
- ``` bash
178
- curl http://localhost:2000
179
- ```
180
- The response will match the output of directly calling [https://api.predic8.de](https://api.predic8.de).
169
+ Test a preconfigured API by opening [http://localhost:2000](http://localhost:2000).
181
170
182
- 3. ** Changing the Configuration**
183
-
184
- To use a custom [proxies.xml](distribution/router/conf/proxies.xml) configuration file, bind it to the Membrane container.
171
+ 3. ** Change the Configuration**
172
+ - Download [proxies.xml](distribution/router/conf/proxies.xml) and modify it
173
+ - Bind the configuration file to the container.
185
174
186
175
# ### For Windows/Linux:
187
176
` ` ` bash
@@ -193,23 +182,24 @@ Learn how API Gateways work with real-world examples and insights into Membrane.
193
182
docker run -v " $( pwd) /proxies.xml:/opt/membrane/conf/proxies.xml" -p 2000:2000 predic8/membrane
194
183
` ` `
195
184
196
- # ## Learn More
197
185
For detailed Docker setup instructions, see the [Membrane Deployment Guide](https://membrane-api.io/deployment/# docker).
198
186
199
-
200
- # # Next Steps
187
+ # # Getting Started
201
188
202
189
# ## Explore and Experiment
203
- - Try the code snippets below .
204
- - Run the samples in the [examples](/ distribution/examples#working-api-gateway-examples) folder of the unzipped distribution.
190
+ - Try the code snippets on this page .
191
+ - Run the samples in the [examples](distribution/examples#working-api-gateway-examples) folder of the distribution.
205
192
206
193
# ## Dive into Tutorials
207
- - Follow the [REST API Tutorial](https://membrane-api.io/tutorials/rest/) to learn about deploying and securing RESTful services .
194
+ - Follow the [REST API Tutorial](https://membrane-api.io/tutorials/rest/) to learn about deploying and securing APIs .
208
195
- Check out the [SOAP API Tutorial](https://membrane-api.io/tutorials/soap/) for legacy web service integration.
209
196
210
- # ## Read the Documentation
197
+ # ## Documentation
211
198
212
- - For detailed guidance, visit the [official documentation](https://www.membrane-api.io).
199
+ - Read the [API Gateway eBook](https://www.membrane-api.io/api-gateway-ebook.html)
200
+ - Look at the [documentation](https://www.membrane-api.io).
201
+ - Browse the [reference](https://www.membrane-api.io/docs/)
202
+ - Try the recipes from the [cookbook](https://www.membrane-api.io/api-gateway-cookbook.html)
213
203
214
204
# Basics
215
205
0 commit comments