Skip to content

Commit e11f964

Browse files
authored
Readme examples minor (#2034)
* fix: log internal fields * fix: fixes #2026 leakage of database connections in JDBC API Key store * docs: examples * docs: examples * docs: examples * docs: examples * docs: examples * docs: examples * docs: examples * docs: examples * docs: image * docs: image * docs: minor * image * rm
1 parent ce5efb4 commit e11f964

File tree

3 files changed

+31
-44
lines changed

3 files changed

+31
-44
lines changed

README.md

Lines changed: 31 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Learn how API Gateways work with real-world examples and insights into Membrane.
8888
- Streams HTTP traffic for low-latency, non-blocking processing.
8989
- Reuses TCP connections via HTTP Keep-Alive to reduce request overhead.
9090
- Lightweight distribution (~55MB) compared to other Java-based gateways.
91-
- Low memory footprintideal for containers and cloud-native environments.
91+
- Low memory footprint, ideal for containers and cloud-native environments.
9292
- Java-based, yet competitive with C/C++ gateways in performance.
9393

9494
# Content
@@ -135,53 +135,42 @@ Learn how API Gateways work with real-world examples and insights into Membrane.
135135
- [Monitoring with Prometheus and Grafana](#monitoring-with-prometheus-and-grafana)
136136
- [OpenTelemetry](#opentelemetry-integration)
137137

138-
# Getting Started
138+
# Installation
139139

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.
144141

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
148143

144+
1. **Download and extract**
145+
- [Download a release](https://github.com/membrane/api-gateway/releases) and unzip it.
149146
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:
152153
- **Linux/Mac:** `./membrane.sh`
153154
- **Windows:** `membrane.cmd`
155+
4. **Access the Gateway**
156+
- Open [http://localhost:2000](http://localhost:2000)
157+
5. **Change the Configuration**
154158

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.
162160

163161
## Docker
164162

165-
### Quick Start
166-
167-
1. **Start the Gateway**
168-
169-
Run Membrane in a container:
163+
1. **Start a Membrane container**
170164
```bash
171165
docker run -p 2000:2000 predic8/membrane
172-
```
173-
166+
```
174167
2. **Access the Gateway**
175168

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).
181170

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.
185174

186175
#### For Windows/Linux:
187176
```bash
@@ -193,23 +182,24 @@ Learn how API Gateways work with real-world examples and insights into Membrane.
193182
docker run -v "$(pwd)/proxies.xml:/opt/membrane/conf/proxies.xml" -p 2000:2000 predic8/membrane
194183
```
195184

196-
### Learn More
197185
For detailed Docker setup instructions, see the [Membrane Deployment Guide](https://membrane-api.io/deployment/#docker).
198186

199-
200-
## Next Steps
187+
## Getting Started
201188

202189
### 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.
205192

206193
### 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.
208195
- Check out the [SOAP API Tutorial](https://membrane-api.io/tutorials/soap/) for legacy web service integration.
209196

210-
### Read the Documentation
197+
### Documentation
211198

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)
213203

214204
# Basics
215205

docs/ROADMAP.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,6 @@
3434

3535
# 6.3.0
3636

37-
- Refactor MessageUtil (TB)
38-
- MessageUtil: Remove getXRequest and use Request Builder instead
3937
- Describe RPM Setup
4038
- examples/routing-traffic/outgoing-api-gateway (TB)
4139
- Cook Book: outgoing-api-gateway (TB)
@@ -46,7 +44,6 @@
4644
- Pretty on text should trim whitespace incl. linebreaks at start and end
4745
- READMEs in example folders listing the examples (TB)
4846
- Refactor HttpClient (TB)
49-
- SampleSOAPService: Add some more cities
5047
- Refactor: interceptor.session
5148

5249
### Internal
16.2 KB
Loading

0 commit comments

Comments
 (0)