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

docs: fix typo in mongo connection string examples #38

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Helm Deploy

You can install Akto via Helm charts.
You can install Akto via Helm charts.

## Resources
Akto's Helm chart repo is on GitHub [here](https://github.com/akto-api-security/helm-charts).
Expand All @@ -11,8 +11,8 @@ Please ensure you have the following -
1. A Kubernetes cluster where you have deploy permissions
2. `helm` command installed. Check [here](https://helm.sh/docs/intro/install/)

## Steps
Here are the steps to install Akto via Helm charts -
## Steps
Here are the steps to install Akto via Helm charts -

1. Prepare Mongo Connection string
2. Install Akto via Helm
Expand All @@ -31,7 +31,7 @@ Akto Helm setup needs a Mongo connection string as input. It can come from eithe
```
<img width="1161" alt="AWS EC2 Mongo" src="https://github.com/akto-api-security/Documentation/assets/91221068/0b6b87e8-9797-4729-ab01-fd48f99efbd3">

The connection string would then be `mongodb://<YOUR_INSTANCE_PRIVATE_IP>:27017/admini`
The connection string would then be `mongodb://<YOUR_INSTANCE_PRIVATE_IP>:27017/admin`
2. **Mongo Atlas**
You can use Mongo Atlas connection as well
1. Go to `Database Deployments` page for your project
Expand All @@ -44,7 +44,7 @@ Akto Helm setup needs a Mongo connection string as input. It can come from eithe
If you are on AWS, you can use AWS Document DB too. You can find the connection string on the Cluster page itself.
<img width="1399" alt="AWS DocDB" src="https://github.com/akto-api-security/Documentation/assets/91221068/4ce4d84d-6e8a-4d4d-bc0b-e5d03e3f824a">

Note: Please ensure your K8S cluster has connectivity to Mongo.
Note: Please ensure your K8S cluster has connectivity to Mongo.

### Install Akto via Helm

Expand Down
12 changes: 6 additions & 6 deletions charts/akto-runtime/README>md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Akto setup

You can install Akto via Helm charts.
You can install Akto via Helm charts.

## Resources
Akto's Helm chart repo is on GitHub [here](https://github.com/akto-api-security/helm-charts).
Expand All @@ -11,8 +11,8 @@ Please ensure you have the following -
1. A Kubernetes cluster where you have deploy permissions
2. `helm` command installed. Check [here](https://helm.sh/docs/intro/install/)

## Steps
Here are the steps to install Akto via Helm charts -
## Steps
Here are the steps to install Akto via Helm charts -

1. Prepare Mongo Connection string
2. Install Akto via Helm
Expand All @@ -31,7 +31,7 @@ Akto Helm setup needs a Mongo connection string as input. It can come from eithe
```
<img width="1161" alt="AWS EC2 Mongo" src="https://github.com/akto-api-security/Documentation/assets/91221068/0b6b87e8-9797-4729-ab01-fd48f99efbd3">

The connection string would then be `mongodb://<YOUR_INSTANCE_PRIVATE_IP>:27017/admini`
The connection string would then be `mongodb://<YOUR_INSTANCE_PRIVATE_IP>:27017/admin`
2. **Mongo Atlas**
You can use Mongo Atlas connection as well
1. Go to `Database Deployments` page for your project
Expand All @@ -44,7 +44,7 @@ Akto Helm setup needs a Mongo connection string as input. It can come from eithe
If you are on AWS, you can use AWS Document DB too. You can find the connection string on the Cluster page itself.
<img width="1399" alt="AWS DocDB" src="https://github.com/akto-api-security/Documentation/assets/91221068/4ce4d84d-6e8a-4d4d-bc0b-e5d03e3f824a">

Note: Please ensure your K8S cluster has connectivity to Mongo.
Note: Please ensure your K8S cluster has connectivity to Mongo.

### Install Akto via Helm

Expand All @@ -60,4 +60,4 @@ Note: Please ensure your K8S cluster has connectivity to Mongo.
1. Run the following to get Akto dashboard url
```kubectl get services/akto-dashboard -n dev | awk -F " " '{print $4;}'```
2. Open Akto dashboard on port 8080. eg `http://a54b36c1f4asdaasdfbd06a259de2-acf687643f6fe4eb.elb.ap-south-1.amazonaws.com:8080/`
3. For good security measures, you should enable HTTPS by adding a certificate and put it behind a VPN. If you are on AWS, follow the guide [here](https://docs.akto.io/getting-started/aws-ssl).
3. For good security measures, you should enable HTTPS by adding a certificate and put it behind a VPN. If you are on AWS, follow the guide [here](https://docs.akto.io/getting-started/aws-ssl).
10 changes: 5 additions & 5 deletions charts/akto-setup-dashboard/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Akto setup

You can install Akto via Helm charts.
You can install Akto via Helm charts.

## Resources
Akto's Helm chart repo is on GitHub [here](https://github.com/akto-api-security/helm-charts).
Expand All @@ -11,8 +11,8 @@ Please ensure you have the following -
1. A Kubernetes cluster where you have deploy permissions
2. `helm` command installed. Check [here](https://helm.sh/docs/intro/install/)

## Steps
Here are the steps to install Akto via Helm charts -
## Steps
Here are the steps to install Akto via Helm charts -

1. Prepare Mongo Connection string
2. Install Akto via Helm
Expand All @@ -31,7 +31,7 @@ Akto Helm setup needs a Mongo connection string as input. It can come from eithe
```
<img width="1161" alt="AWS EC2 Mongo" src="https://github.com/akto-api-security/Documentation/assets/91221068/0b6b87e8-9797-4729-ab01-fd48f99efbd3">

The connection string would then be `mongodb://<YOUR_INSTANCE_PRIVATE_IP>:27017/admini`
The connection string would then be `mongodb://<YOUR_INSTANCE_PRIVATE_IP>:27017/admin`
2. **Mongo Atlas**
You can use Mongo Atlas connection as well
1. Go to `Database Deployments` page for your project
Expand All @@ -44,7 +44,7 @@ Akto Helm setup needs a Mongo connection string as input. It can come from eithe
If you are on AWS, you can use AWS Document DB too. You can find the connection string on the Cluster page itself.
<img width="1399" alt="AWS DocDB" src="https://github.com/akto-api-security/Documentation/assets/91221068/4ce4d84d-6e8a-4d4d-bc0b-e5d03e3f824a">

Note: Please ensure your K8S cluster has connectivity to Mongo.
Note: Please ensure your K8S cluster has connectivity to Mongo.

### Install Akto via Helm

Expand Down
12 changes: 6 additions & 6 deletions charts/akto-setup-database-abstractor/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Akto setup

You can install Akto via Helm charts.
You can install Akto via Helm charts.

## Resources
Akto's Helm chart repo is on GitHub [here](https://github.com/akto-api-security/helm-charts).
Expand All @@ -11,8 +11,8 @@ Please ensure you have the following -
1. A Kubernetes cluster where you have deploy permissions
2. `helm` command installed. Check [here](https://helm.sh/docs/intro/install/)

## Steps
Here are the steps to install Akto via Helm charts -
## Steps
Here are the steps to install Akto via Helm charts -

1. Prepare Mongo Connection string
2. Install Akto via Helm
Expand All @@ -31,7 +31,7 @@ Akto Helm setup needs a Mongo connection string as input. It can come from eithe
```
<img width="1161" alt="AWS EC2 Mongo" src="https://github.com/akto-api-security/Documentation/assets/91221068/0b6b87e8-9797-4729-ab01-fd48f99efbd3">

The connection string would then be `mongodb://<YOUR_INSTANCE_PRIVATE_IP>:27017/admini`
The connection string would then be `mongodb://<YOUR_INSTANCE_PRIVATE_IP>:27017/admin`
2. **Mongo Atlas**
You can use Mongo Atlas connection as well
1. Go to `Database Deployments` page for your project
Expand All @@ -44,7 +44,7 @@ Akto Helm setup needs a Mongo connection string as input. It can come from eithe
If you are on AWS, you can use AWS Document DB too. You can find the connection string on the Cluster page itself.
<img width="1399" alt="AWS DocDB" src="https://github.com/akto-api-security/Documentation/assets/91221068/4ce4d84d-6e8a-4d4d-bc0b-e5d03e3f824a">

Note: Please ensure your K8S cluster has connectivity to Mongo.
Note: Please ensure your K8S cluster has connectivity to Mongo.

### Install Akto via Helm

Expand All @@ -60,4 +60,4 @@ Note: Please ensure your K8S cluster has connectivity to Mongo.
1. Run the following to get Akto dashboard url
```kubectl get services/akto-dashboard -n dev | awk -F " " '{print $4;}'```
2. Open Akto dashboard on port 8080. eg `http://a54b36c1f4asdaasdfbd06a259de2-acf687643f6fe4eb.elb.ap-south-1.amazonaws.com:8080/`
3. For good security measures, you should enable HTTPS by adding a certificate and put it behind a VPN. If you are on AWS, follow the guide [here](https://docs.akto.io/getting-started/aws-ssl).
3. For good security measures, you should enable HTTPS by adding a certificate and put it behind a VPN. If you are on AWS, follow the guide [here](https://docs.akto.io/getting-started/aws-ssl).
10 changes: 5 additions & 5 deletions charts/akto-setup/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Akto setup

You can install Akto via Helm charts.
You can install Akto via Helm charts.

## Resources
Akto's Helm chart repo is on GitHub [here](https://github.com/akto-api-security/helm-charts).
Expand All @@ -11,8 +11,8 @@ Please ensure you have the following -
1. A Kubernetes cluster where you have deploy permissions
2. `helm` command installed. Check [here](https://helm.sh/docs/intro/install/)

## Steps
Here are the steps to install Akto via Helm charts -
## Steps
Here are the steps to install Akto via Helm charts -

1. Prepare Mongo Connection string
2. Install Akto via Helm
Expand All @@ -31,7 +31,7 @@ Akto Helm setup needs a Mongo connection string as input. It can come from eithe
```
<img width="1161" alt="AWS EC2 Mongo" src="https://github.com/akto-api-security/Documentation/assets/91221068/0b6b87e8-9797-4729-ab01-fd48f99efbd3">

The connection string would then be `mongodb://<YOUR_INSTANCE_PRIVATE_IP>:27017/admini`
The connection string would then be `mongodb://<YOUR_INSTANCE_PRIVATE_IP>:27017/admin`
2. **Mongo Atlas**
You can use Mongo Atlas connection as well
1. Go to `Database Deployments` page for your project
Expand All @@ -44,7 +44,7 @@ Akto Helm setup needs a Mongo connection string as input. It can come from eithe
If you are on AWS, you can use AWS Document DB too. You can find the connection string on the Cluster page itself.
<img width="1399" alt="AWS DocDB" src="https://github.com/akto-api-security/Documentation/assets/91221068/4ce4d84d-6e8a-4d4d-bc0b-e5d03e3f824a">

Note: Please ensure your K8S cluster has connectivity to Mongo.
Note: Please ensure your K8S cluster has connectivity to Mongo.

### Install Akto via Helm

Expand Down
12 changes: 6 additions & 6 deletions charts/mini-runtime/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Akto setup

You can install Akto via Helm charts.
You can install Akto via Helm charts.

## Resources
Akto's Helm chart repo is on GitHub [here](https://github.com/akto-api-security/helm-charts).
Expand All @@ -11,8 +11,8 @@ Please ensure you have the following -
1. A Kubernetes cluster where you have deploy permissions
2. `helm` command installed. Check [here](https://helm.sh/docs/intro/install/)

## Steps
Here are the steps to install Akto via Helm charts -
## Steps
Here are the steps to install Akto via Helm charts -

1. Prepare Mongo Connection string
2. Install Akto via Helm
Expand All @@ -31,7 +31,7 @@ Akto Helm setup needs a Mongo connection string as input. It can come from eithe
```
<img width="1161" alt="AWS EC2 Mongo" src="https://github.com/akto-api-security/Documentation/assets/91221068/0b6b87e8-9797-4729-ab01-fd48f99efbd3">

The connection string would then be `mongodb://<YOUR_INSTANCE_PRIVATE_IP>:27017/admini`
The connection string would then be `mongodb://<YOUR_INSTANCE_PRIVATE_IP>:27017/admin`
2. **Mongo Atlas**
You can use Mongo Atlas connection as well
1. Go to `Database Deployments` page for your project
Expand All @@ -44,7 +44,7 @@ Akto Helm setup needs a Mongo connection string as input. It can come from eithe
If you are on AWS, you can use AWS Document DB too. You can find the connection string on the Cluster page itself.
<img width="1399" alt="AWS DocDB" src="https://github.com/akto-api-security/Documentation/assets/91221068/4ce4d84d-6e8a-4d4d-bc0b-e5d03e3f824a">

Note: Please ensure your K8S cluster has connectivity to Mongo.
Note: Please ensure your K8S cluster has connectivity to Mongo.

### Install Akto via Helm

Expand All @@ -60,4 +60,4 @@ Note: Please ensure your K8S cluster has connectivity to Mongo.
1. Run the following to get Akto dashboard url
```kubectl get services/akto-dashboard -n dev | awk -F " " '{print $4;}'```
2. Open Akto dashboard on port 8080. eg `http://a54b36c1f4asdaasdfbd06a259de2-acf687643f6fe4eb.elb.ap-south-1.amazonaws.com:8080/`
3. For good security measures, you should enable HTTPS by adding a certificate and put it behind a VPN. If you are on AWS, follow the guide [here](https://docs.akto.io/getting-started/aws-ssl).
3. For good security measures, you should enable HTTPS by adding a certificate and put it behind a VPN. If you are on AWS, follow the guide [here](https://docs.akto.io/getting-started/aws-ssl).
12 changes: 6 additions & 6 deletions charts/source-code-analyser/README>md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Akto setup

You can install Akto via Helm charts.
You can install Akto via Helm charts.

## Resources
Akto's Helm chart repo is on GitHub [here](https://github.com/akto-api-security/helm-charts).
Expand All @@ -11,8 +11,8 @@ Please ensure you have the following -
1. A Kubernetes cluster where you have deploy permissions
2. `helm` command installed. Check [here](https://helm.sh/docs/intro/install/)

## Steps
Here are the steps to install Akto via Helm charts -
## Steps
Here are the steps to install Akto via Helm charts -

1. Prepare Mongo Connection string
2. Install Akto via Helm
Expand All @@ -31,7 +31,7 @@ Akto Helm setup needs a Mongo connection string as input. It can come from eithe
```
<img width="1161" alt="AWS EC2 Mongo" src="https://github.com/akto-api-security/Documentation/assets/91221068/0b6b87e8-9797-4729-ab01-fd48f99efbd3">

The connection string would then be `mongodb://<YOUR_INSTANCE_PRIVATE_IP>:27017/admini`
The connection string would then be `mongodb://<YOUR_INSTANCE_PRIVATE_IP>:27017/admin`
2. **Mongo Atlas**
You can use Mongo Atlas connection as well
1. Go to `Database Deployments` page for your project
Expand All @@ -44,7 +44,7 @@ Akto Helm setup needs a Mongo connection string as input. It can come from eithe
If you are on AWS, you can use AWS Document DB too. You can find the connection string on the Cluster page itself.
<img width="1399" alt="AWS DocDB" src="https://github.com/akto-api-security/Documentation/assets/91221068/4ce4d84d-6e8a-4d4d-bc0b-e5d03e3f824a">

Note: Please ensure your K8S cluster has connectivity to Mongo.
Note: Please ensure your K8S cluster has connectivity to Mongo.

### Install Akto via Helm

Expand All @@ -60,4 +60,4 @@ Note: Please ensure your K8S cluster has connectivity to Mongo.
1. Run the following to get Akto dashboard url
```kubectl get services/akto-dashboard -n dev | awk -F " " '{print $4;}'```
2. Open Akto dashboard on port 8080. eg `http://a54b36c1f4asdaasdfbd06a259de2-acf687643f6fe4eb.elb.ap-south-1.amazonaws.com:8080/`
3. For good security measures, you should enable HTTPS by adding a certificate and put it behind a VPN. If you are on AWS, follow the guide [here](https://docs.akto.io/getting-started/aws-ssl).
3. For good security measures, you should enable HTTPS by adding a certificate and put it behind a VPN. If you are on AWS, follow the guide [here](https://docs.akto.io/getting-started/aws-ssl).