From 00215eeedd38dd9300ee7bb576bccb72cb0f2a27 Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Fri, 25 Nov 2022 14:49:21 -0500 Subject: [PATCH] Restructure docs for better navigation --- README.md | 2 +- backend/src/helpers/rateLimiter.ts | 8 ++++---- docs/integrations/docker-compose.mdx | 22 +++++++++++++--------- docs/integrations/docker.mdx | 2 +- docs/integrations/overview.mdx | 5 +++++ docs/mint.json | 4 ++-- 6 files changed, 26 insertions(+), 17 deletions(-) create mode 100644 docs/integrations/overview.mdx diff --git a/README.md b/README.md index 56ebbea71b..1c74bed474 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/backend/src/helpers/rateLimiter.ts b/backend/src/helpers/rateLimiter.ts index eb51125603..a0788246aa 100644 --- a/backend/src/helpers/rateLimiter.ts +++ b/backend/src/helpers/rateLimiter.ts @@ -3,7 +3,7 @@ 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 }); @@ -11,7 +11,7 @@ const apiLimiter = rateLimit({ // 5 requests per hour const signupLimiter = rateLimit({ windowMs: 60 * 60 * 1000, - max: 5, + max: 10, standardHeaders: true, legacyHeaders: false }); @@ -19,7 +19,7 @@ const signupLimiter = rateLimit({ // 10 requests per hour const loginLimiter = rateLimit({ windowMs: 60 * 60 * 1000, - max: 10, + max: 20, standardHeaders: true, legacyHeaders: false }); @@ -27,7 +27,7 @@ const loginLimiter = rateLimit({ // 5 requests per hour const passwordLimiter = rateLimit({ windowMs: 60 * 60 * 1000, - max: 5, + max: 10, standardHeaders: true, legacyHeaders: false }); diff --git a/docs/integrations/docker-compose.mdx b/docs/integrations/docker-compose.mdx index a7310ad85d..97ce0aba07 100644 --- a/docs/integrations/docker-compose.mdx +++ b/docs/integrations/docker-compose.mdx @@ -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. -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. ### 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: @@ -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 @@ -51,6 +55,6 @@ export INFISICAL_TOKEN_FOR_WEB= # Token refers to the token we generated in step 2 for this service export INFISICAL_TOKEN_FOR_API= -# Then run your compose file in the same terminal. +# Then run your compose file in the same terminal. docker-compose ... ``` diff --git a/docs/integrations/docker.mdx b/docs/integrations/docker.mdx index 7d66f3db69..68ac7b5741 100644 --- a/docs/integrations/docker.mdx +++ b/docs/integrations/docker.mdx @@ -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 diff --git a/docs/integrations/overview.mdx b/docs/integrations/overview.mdx new file mode 100644 index 0000000000..e496ce4882 --- /dev/null +++ b/docs/integrations/overview.mdx @@ -0,0 +1,5 @@ +--- +title: "Overview" +--- + +Infisical integrates with a range of technologies. diff --git a/docs/mint.json b/docs/mint.json index 4ee36a37cb..d022f258db 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -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": [ {