Skip to content

Commit 882ed6e

Browse files
authored
refactor: remove outdated keys.txt and improve README.md and XML configuration samples for clarity (#2390)
1 parent 0d6d5d8 commit 882ed6e

3 files changed

Lines changed: 14 additions & 17 deletions

File tree

distribution/conf/keys.txt

Lines changed: 0 additions & 4 deletions
This file was deleted.

distribution/router/conf/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
This folder contains the Membrane configuration. More configuration samples could be found in the [tutorial](../tutorials) and [examples](../examples) folders.
44

5+
56
## Starting Membrane
67

7-
Run Membrane with the configuration from this folder:
8+
Run Membrane with the configuration in this folder:
89

910
```
1011
cd membrane-api-gateway-<VERSION>
@@ -14,15 +15,21 @@ cd membrane-api-gateway-<VERSION>
1415

1516
## YAML Configuration
1617

17-
Use the 'apis.yaml' file to configure your APIs. You can remove the inactive XML file.
18+
Use the 'apis.yaml' file to configure your APIs. The 'apis.yaml' has precedence over the 'proxies.xml' file.
19+
20+
You can remove the inactive XML file in case you do not want to use the YAML configuration.
1821

22+
```
1923
rm proxies.xml.inactive
24+
```
2025

2126

2227
## XML Configuration
2328

24-
To switch back to XML:
29+
To switch back to the XML configuration:
2530

31+
```
2632
rm apis.yaml
2733
mv proxies.xml.inactive proxies.xml
34+
```
2835

distribution/router/conf/proxies.xml renamed to distribution/router/conf/proxies.xml.inactive

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
<!--
2-
*** Membrane Configuration ***
2+
*** XML Configuration Sample ***
33

4-
Try the new experimental YAML configuration in apis.yaml!
4+
How to use the XML configuration:
55

6-
Stay with the XML in case you have complicated setups with beans till YAML supports all the functions of Membrane.
7-
8-
For more see:
9-
- The examples/* folders with working samples
10-
- Configuration Reference: https://www.membrane-api.io/docs/
11-
12-
Use an XML editor with XML Schema syntax completion for easy editing like
13-
Visual Studio Code or Intellij.
6+
1.) Rename this file to proxies.xml
7+
2.) Delete the apis.yaml file
148

159
-->
1610
<spring:beans xmlns="http://membrane-soa.org/proxies/1/"

0 commit comments

Comments
 (0)