Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README.md with latest changes #534

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Zen, your in-app firewall for peace of mind– at runtime.

Zen by Aikido is an embedded Web Application Firewall that autonomously protects Node.js apps against common and critical attacks.

It protects your Node.js apps by preventing user input containing dangerous strings, which allow injection, pollution, and path traversal attacks. It runs on the same server as your Node.js app for simple [installation](#installation) and zero maintenance.
It protects your Node.js apps by scanning user input and where that data eventually flows to, allowing Zen to more accurately block SQL Injections, Path traversal attacks, and more. It runs on the same server as your Node.js app for simple [installation](#installation) and zero maintenance.

## Features

Expand All @@ -30,6 +30,9 @@ Zen will autonomously protect your Node.js applications against:
Zen operates autonomously on the same server as your Node.js app to:

* ✅ Secure your app like a classic web application firewall (WAF), but with none of the infrastructure or cost.
* ✅ Auto-generate API specifications
* ✅ Block known threat actors and bots.
* ✅ Geo-fencing to block or allow a selection of countries
* ✅ Rate limit specific API endpoints by IP or by user
* ✅ Allow you to block specific users manually
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
*Allow you to block specific users manually
*Allows you to block specific users manually


Expand Down Expand Up @@ -129,13 +132,16 @@ For framework- and provider- specific instructions, check out our docs:

> Aikido is your no nonsense application security platform. One central system that scans your source code & cloud, shows you what vulnerabilities matter, and how to fix them - fast. So you can get back to building.

Zen is a new product by Aikido. Built for developers to level up their security. While Aikido scans, get Zen for always-on protection.
Zen improves Aikido's offering by providing you with security in production. Use the automatic generation of API specifications together with our DAST offering for even better API Security.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace DAST with API scanning or something similar?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had no idea what DAST was and we want to bring these features to more engineers, so using industry terms will just confuse.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Zen improves Aikido's offering by providing you with security in production. Use the automatic generation of API specifications together with our DAST offering for even better API Security.
Zen improves Aikido's offering by providing you with security in production. Use the automatic generation of API specifications together with our API scanning offering for even better API Security.


You can use some of Zen’s features without Aikido, of course. Peace of mind is just a few lines of code away.
Only the necessary data gets reported back to Aikido, we scan your requests locally and only report back data once every 10 minutes.
If an attack on your application is detected, we report immediately allowing you to take swift action.

But you will get the most value by reporting your data to Aikido.
You can easily select which IP addresses and/or bots to block from curated lists inside our Dashboard.

You will need an Aikido account and a token to report events to Aikido. If you don't have an account, you can [sign up for free](https://app.aikido.dev/login).
Running Zen locally without Aikido is possibly but the feature set is limited and we don't recommend this setup for production environments.

You will need an Aikido account and a token to report events to Aikido. If you don't have an account, you can [sign up for free](https://app.aikido.dev/login). (No credit card required)

Here's how:
* [Log in to your Aikido account](https://app.aikido.dev/login).
Expand Down
Loading