Skip to content

Commit

Permalink
Merge pull request #109 from mantiumai/AlexN/update-readme
Browse files Browse the repository at this point in the history
update readme quick start steps to remove fernet key
  • Loading branch information
rseveymant authored Jul 27, 2023
2 parents b7cfae5 + e888619 commit 188e8ab
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,16 @@
Chirps is a Django-based Python web application that allows users to search and scan vector databases for sensitive data. The application can connect to [Mantium](https://mantiumai.com/) applications and to vector databases like Redis and Pinecone. Users can create and manage scanning plans, execute scans against an asset using a selected plan, and view the results of the scan, including any findings.

![architecture](https://github.com/mantiumai/chirps/blob/main/docs/assets/images/application_architecture.png)

## Quick Start

- `pip install -r requirements.txt`
- create a .env file in /chirps with `FERNET_KEY`=
- Enter in a Fernet key - must be 32 url-safe base64-encoded bytes. You can use the python script in `/chirps/chirps/key_script.py` to generate one.
- Navigate to /chirps and run `./manage.py initialize_app` to start the application and necessary services
- Initialize the app by running the following command `./chirps/manage.py initialize_app`
- In the codespace, click "Ports" on the lower toolbar and click the link under "Forwarded Ports" to access the application at port 8000.
- Create a user account in the UI.

## Getting Started
Please familiarize yourself with the project by visiting our [Getting Started](https://chirps.mantiumai.com/getting-started/) page.

## Support

Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The `Profile` model extends Django's built-in User model with a one-to-one relat
## Quick Start

- `pip install -r requirements.txt`
- Navigate to /Chirps and run `./manage.py initialize_app`
- Initialize the app by running the following command `./chirps/manage.py initialize_app`
- In the codespace, click "Ports" on the lower toolbar and click the link under "Forwarded Ports" to access the application at port 8000.
- Create a user account in the UI.

Expand Down

0 comments on commit 188e8ab

Please sign in to comment.