Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wernerdaehn committed Jan 26, 2025
1 parent 829ca3a commit 8422f69
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ For proper start commands, especially https and security related, see the [Conne

The first step is to connect the application to a Kafka server and the schema registry. In the settings screen the normal Kafka properties file data can be pasted and saved. By default the file location is `/apps/rulesservice/settings/kafka.properties` from the container's point of view.

<img src="docs/media/Config.png" width="50%">
<img src="https://raw.githubusercontent.com/rtdi/RulesService/refs/heads/main/docs/media/Config.png" width="50%">


```
Expand All @@ -92,7 +92,7 @@ To simplify entering rules, sample values can be entered and the result be recal

Once a rule file is complete, it must be copied from the `inactive` to the `active` directory. The button `Activate` does that. The reason for this two staged approach is to allow users saving intermediate definitions without impacting the currently running service.

<img src="https://github.com/rtdi/RulesService/blob/main/docs/media/Rule.png" width="50%">
<img src="https://raw.githubusercontent.com/rtdi/RulesService/refs/heads/main/main/docs/media/Rule.png" width="50%">


### Step 3: Topics
Expand All @@ -115,7 +115,7 @@ Querying this data allows detailed reporting which records were processed by wha

The exact Avro schema field definition can be found [here](docs/audit-schema.md)

<img src="https://github.com/rtdi/RulesService/blob/main/docs/media/RuleResult.png" width="50%">
<img src="https://raw.githubusercontent.com/rtdi/RulesService/refs/heads/main/docs/media/RuleResult.png" width="50%">


### Sample files
Expand All @@ -126,7 +126,7 @@ The found messages are streamed in chunks into the screen and can be saved, eith
The files are stored in the directory `/apps/rulesservice/definitions/<subjectname>/sampledata/`.
If no file name is specified, the name will be `partition_<partition>_offset_<offset>.json`.

<img src="https://github.com/rtdi/RulesService/blob/main/docs/media/SampleData.png" width="50%">
<img src="https://raw.githubusercontent.com/rtdi/RulesService/refs/heads/main/docs/media/SampleData.png" width="50%">


<a name="b4"/>
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<packaging>war</packaging>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<revision>0.9.28</revision>
<revision>0.9.29</revision>
<log4j.version>2.24.1</log4j.version>
<kafka.version>3.8.0</kafka.version>
<jersey>3.1.8</jersey>
Expand Down

0 comments on commit 8422f69

Please sign in to comment.