Skip to content

Commit

Permalink
Updating the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
jzonthemtn committed Sep 14, 2024
1 parent 053d7e6 commit fff5b4f
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,11 @@ Philter is available on the cloud marketplaces as a turnkey redaction solution.

AI models for identifying PII and PHI in text are available at https://github.com/philterd/pii-models. These models can be used by both Phileas and [Philter](https://github.com/philterd/philter).

## Quick Start
## Running Philter

Philter can be run using `docker compose` after building:
To launch Philter, use the `docker-compose.yml`:

```
mvn clean install
docker compose build
docker compose up
```

Expand All @@ -34,6 +32,14 @@ Once the containers are running, you can submit text to Philter's API for redact
curl -k "https://localhost:8080/api/filter" --data "George Washington lives in 90210 and his SSN was 123-45-6789." -H "Content-type: text/plain"
```

## Build Philter

Philter is built with Maven:

```
mvn clean install
```

## License

As of Philter 2.6.0, Philter is licensed under the Apache License, version 2.0. Previous versions were under a proprietary license.
Expand Down

0 comments on commit fff5b4f

Please sign in to comment.