Skip to content

Commit

Permalink
Restructure docs for better navigation
Browse files Browse the repository at this point in the history
  • Loading branch information
Tuan Dang committed Nov 25, 2022
1 parent 7e4b38a commit 00215ee
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 17 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
**[Infisical](https://infisical.com)** is an open source, E2EE tool to help teams manage and sync environment variables across their development workflow and infrastructure. It's designed to be simple and take minutes to get going.

- **User-Friendly Dashboard** to manage your team's environment variables within projects
- **[Language-Agnostic CLI](https://infisical.com/docs/CLI)** that pulls and injects environment variables into your local workflow
- **[Language-Agnostic CLI](https://infisical.com/docs/getting-started/cli/installation)** that pulls and injects environment variables into your local workflow
- **[Complete control over your data](https://infisical.com/docs/self_host_overview)** - host it yourself on any infrastructure
- **Navigate Multiple Environments** per project (e.g. development, staging, production, etc.)
- **Personal/Shared** scoping for environment variables
Expand Down
8 changes: 4 additions & 4 deletions backend/src/helpers/rateLimiter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,31 @@ import rateLimit from 'express-rate-limit';
// 300 requests per 15 minutes
const apiLimiter = rateLimit({
windowMs: 15 * 60 * 1000,
max: 300,
max: 400,
standardHeaders: true,
legacyHeaders: false
});

// 5 requests per hour
const signupLimiter = rateLimit({
windowMs: 60 * 60 * 1000,
max: 5,
max: 10,
standardHeaders: true,
legacyHeaders: false
});

// 10 requests per hour
const loginLimiter = rateLimit({
windowMs: 60 * 60 * 1000,
max: 10,
max: 20,
standardHeaders: true,
legacyHeaders: false
});

// 5 requests per hour
const passwordLimiter = rateLimit({
windowMs: 60 * 60 * 1000,
max: 5,
max: 10,
standardHeaders: true,
legacyHeaders: false
});
Expand Down
22 changes: 13 additions & 9 deletions docs/integrations/docker-compose.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,26 @@ title: "Docker Compose"
---

### Step 1: Add CLI to your Dockerfile
Follow steps 1 through 3 on our [guide to configure Infisical CLI](/docker) in your Dockerfile.

Follow steps 1 through 3 on our [guide to configure Infisical CLI](../getting-started/cli/installation) in your Dockerfile.

### Step 2: Generate Infisical Token

In order for Infisical CLI to authenticate and retrieve your project's secrets without exposing your login credentials, you must generate a Infisical Token.
To learn how, visit [Infisical Token](../getting-started/cli/infisical-token). Once you have generated the token, keep it handy.
To learn how, visit [Infisical Token](../getting-started/cli/infisical-token). Once you have generated the token, keep it handy.

<Info>
If you have multiple services and they do not use the same secrets, you will have to generate a Infisical Token for each service.
If you have multiple services and they do not use the same secrets, you will
have to generate a Infisical Token for each service.
</Info>

### Step 3: Tell Docker Compose your Infisical Token

For each service you want to inject secrets into, set an environment variable called `INFISICAL_TOKEN` equal to a helpful identifier variable.
This will ensure that you can set Infisical Tokens for multiple services.
This will ensure that you can set Infisical Tokens for multiple services.

For the example below, we have set `INFISICAL_TOKEN_FOR_WEB` and `INFISICAL_TOKEN_FOR_API` as the `INFISICAL_TOKEN` for the corresponding service.


```yaml
# Example Docker Compose file
services:
Expand All @@ -36,13 +39,14 @@ services:
container_name: auledge-backend
environment:
- INFISICAL_TOKEN=${INFISICAL_TOKEN_FOR_API}

```
### 4: Export shell variables
Next, set the shell variables you defined in your compose file. This can be done manually or via your CI/CD environment. Once done, it will be used to populate the corresponding `INFISICAL_TOKEN`
in your Docker Compose file.
in your Docker Compose file.

``` bash
```bash
#Example
# Token refers to the token we generated in step 2 for this service
Expand All @@ -51,6 +55,6 @@ export INFISICAL_TOKEN_FOR_WEB=<token>
# Token refers to the token we generated in step 2 for this service
export INFISICAL_TOKEN_FOR_API=<token>
# Then run your compose file in the same terminal.
# Then run your compose file in the same terminal.
docker-compose ...
```
2 changes: 1 addition & 1 deletion docs/integrations/docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Docker"
---

Prerequisite: [Infisical Token and How to Generate One](../../getting-started/dashboard/token).
Prerequisite: [Infisical Token and How to Generate One](../getting-started/dashboard/token).

## Step 1: Add CLI to your Dockerfile

Expand Down
5 changes: 5 additions & 0 deletions docs/integrations/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Overview"
---

Infisical integrates with a range of technologies.
4 changes: 2 additions & 2 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@
"to": "#F8B7BD"
}
},
"topbarLinks": [{ "name": "Log In", "url": "https://infisical.com/login" }],
"topbarLinks": [{ "name": "Log In", "url": "https://app.infisical.com/login" }],
"topbarCtaButton": {
"name": "Start for Free",
"url": "https://infisical.com/signup"
"url": "https://app.infisical.com/signup"
},
"anchors": [
{
Expand Down

0 comments on commit 00215ee

Please sign in to comment.