mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-09-22 13:39:35 +00:00
Restructure docs for better navigation
This commit is contained in:
@@ -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.
|
**[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
|
- **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
|
- **[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.)
|
- **Navigate Multiple Environments** per project (e.g. development, staging, production, etc.)
|
||||||
- **Personal/Shared** scoping for environment variables
|
- **Personal/Shared** scoping for environment variables
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ import rateLimit from 'express-rate-limit';
|
|||||||
// 300 requests per 15 minutes
|
// 300 requests per 15 minutes
|
||||||
const apiLimiter = rateLimit({
|
const apiLimiter = rateLimit({
|
||||||
windowMs: 15 * 60 * 1000,
|
windowMs: 15 * 60 * 1000,
|
||||||
max: 300,
|
max: 400,
|
||||||
standardHeaders: true,
|
standardHeaders: true,
|
||||||
legacyHeaders: false
|
legacyHeaders: false
|
||||||
});
|
});
|
||||||
@@ -11,7 +11,7 @@ const apiLimiter = rateLimit({
|
|||||||
// 5 requests per hour
|
// 5 requests per hour
|
||||||
const signupLimiter = rateLimit({
|
const signupLimiter = rateLimit({
|
||||||
windowMs: 60 * 60 * 1000,
|
windowMs: 60 * 60 * 1000,
|
||||||
max: 5,
|
max: 10,
|
||||||
standardHeaders: true,
|
standardHeaders: true,
|
||||||
legacyHeaders: false
|
legacyHeaders: false
|
||||||
});
|
});
|
||||||
@@ -19,7 +19,7 @@ const signupLimiter = rateLimit({
|
|||||||
// 10 requests per hour
|
// 10 requests per hour
|
||||||
const loginLimiter = rateLimit({
|
const loginLimiter = rateLimit({
|
||||||
windowMs: 60 * 60 * 1000,
|
windowMs: 60 * 60 * 1000,
|
||||||
max: 10,
|
max: 20,
|
||||||
standardHeaders: true,
|
standardHeaders: true,
|
||||||
legacyHeaders: false
|
legacyHeaders: false
|
||||||
});
|
});
|
||||||
@@ -27,7 +27,7 @@ const loginLimiter = rateLimit({
|
|||||||
// 5 requests per hour
|
// 5 requests per hour
|
||||||
const passwordLimiter = rateLimit({
|
const passwordLimiter = rateLimit({
|
||||||
windowMs: 60 * 60 * 1000,
|
windowMs: 60 * 60 * 1000,
|
||||||
max: 5,
|
max: 10,
|
||||||
standardHeaders: true,
|
standardHeaders: true,
|
||||||
legacyHeaders: false
|
legacyHeaders: false
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -3,23 +3,26 @@ title: "Docker Compose"
|
|||||||
---
|
---
|
||||||
|
|
||||||
### Step 1: Add CLI to your Dockerfile
|
### 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
|
### 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.
|
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>
|
<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>
|
</Info>
|
||||||
|
|
||||||
### Step 3: Tell Docker Compose your Infisical Token
|
### 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.
|
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.
|
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
|
```yaml
|
||||||
# Example Docker Compose file
|
# Example Docker Compose file
|
||||||
services:
|
services:
|
||||||
@@ -36,13 +39,14 @@ services:
|
|||||||
container_name: auledge-backend
|
container_name: auledge-backend
|
||||||
environment:
|
environment:
|
||||||
- INFISICAL_TOKEN=${INFISICAL_TOKEN_FOR_API}
|
- INFISICAL_TOKEN=${INFISICAL_TOKEN_FOR_API}
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4: Export shell variables
|
### 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`
|
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
|
#Example
|
||||||
|
|
||||||
# Token refers to the token we generated in step 2 for this service
|
# Token refers to the token we generated in step 2 for this service
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: "Docker"
|
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
|
## Step 1: Add CLI to your Dockerfile
|
||||||
|
|
||||||
|
|||||||
5
docs/integrations/overview.mdx
Normal file
5
docs/integrations/overview.mdx
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
title: "Overview"
|
||||||
|
---
|
||||||
|
|
||||||
|
Infisical integrates with a range of technologies.
|
||||||
@@ -21,10 +21,10 @@
|
|||||||
"to": "#F8B7BD"
|
"to": "#F8B7BD"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"topbarLinks": [{ "name": "Log In", "url": "https://infisical.com/login" }],
|
"topbarLinks": [{ "name": "Log In", "url": "https://app.infisical.com/login" }],
|
||||||
"topbarCtaButton": {
|
"topbarCtaButton": {
|
||||||
"name": "Start for Free",
|
"name": "Start for Free",
|
||||||
"url": "https://infisical.com/signup"
|
"url": "https://app.infisical.com/signup"
|
||||||
},
|
},
|
||||||
"anchors": [
|
"anchors": [
|
||||||
{
|
{
|
||||||
|
|||||||
Reference in New Issue
Block a user