Skip to content

Commit 4a57538

Browse files
committed
fix: update readme
1 parent 3331b27 commit 4a57538

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

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

33
[![Known Vulnerabilities](https://snyk.io//test/github/PayU/fluent-plugin-masking/badge.svg?targetFile=Gemfile.lock)](https://snyk.io//test/github/PayU/fluent-plugin-masking?targetFile=Gemfile.lock) [![Build Status](https://travis-ci.com/PayU/fluent-plugin-masking.svg?branch=master)](https://travis-ci.com/PayU/fluent-plugin-masking)
44

5-
# Overview
5+
## Overview
66
Fluentd filter plugin to mask sensitive or privacy records with `*******` in place of the original value. This data masking plugin protects data such as name, email, phonenumber, address, and any other field you would like to mask.
77

8-
# Requirements
8+
## Requirements
99
| fluent-plugin-masking | fluentd | ruby |
1010
| --------------------- | ---------- | ------ |
1111
| 1.2.x | >= v0.14.0 | >= 2.5 |
1212

1313

14-
# Installation
14+
## Installation
1515
Install with gem:
1616

1717
`fluent-gem install fluent-plugin-masking`
1818

19-
# Setup
20-
In order to setup this plugin, the parameter `fieldsToMaskFilePath` needs to be a valid path to a file containing a list of all the fields to mask. The file should have a unique field on each line. These fields **are** case-sensitive (`Name` != `name`).
19+
## Setup
20+
In order to setup this plugin, the parameter `fieldsToMaskFilePath` needs to be a valid path to a file containing a list of all the fields to mask. The file should have a unique field on each line. These fields **are** case-sensitive (`Name` != `name`). if you one or more of the fields will be case insensitive, use the `/i` suffix in your field. see example below.
2121

2222
### Optional configuration
2323
- `fieldsToExcludeJSONPaths` - this field receives as input a comma separated string of JSON fields that should be excluded in the masking procedure. Nested JSON fields are supported by `dot notation` (i.e: `path.to.excluded.field.in.record.nestedExcludedField`) The JSON fields that are excluded are comma separated.
@@ -42,7 +42,7 @@ email
4242
phone/i # the '/i' suffix will make sure phone field will be case insensitive
4343
```
4444

45-
# Quick Guide
45+
## Quick Guide
4646

4747
### Configuration:
4848
```
@@ -102,12 +102,12 @@ echo '{ :body => "{\"first_name\":\"mickey\", \"type\":\"puggle\", \"last_name\"
102102
2019-12-01 14:25:53.385681000 +0300 maskme: {"message":"{ :body => \"{\\\"first_name\\\":\\\"mickey\\\", \\\"type\\\":\\\"puggle\\\", \\\"last_name\\\":\\\"the-dog\\\", \\\"password\\\":\\\"*******\\\"}\"}"}
103103
```
104104

105-
# Run Unit Tests
105+
## Run Unit Tests
106106
```
107107
gem install bundler
108108
bundle install
109109
ruby -r ./test/*.rb
110110
```
111111

112-
# Special escaped json cases handling
112+
## Special escaped json cases handling
113113

0 commit comments

Comments
 (0)