awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-09-22 13:39:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Restructure docs around new anchors

Browse Source
This commit is contained in:
Tuan Dang
2022-11-27 23:36:50 -05:00
parent 798eb67296
commit 0a9f4ffc4d
11 changed files with 132 additions and 144 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/contributing/developing.mdx
View File

@@ -16,7 +16,7 @@ cd infisical
## Set up environment variables ## Set up environment variables
Tweak the `.env` according to your preferences. Refer to the available [environment variables](envars). Tweak the `.env` according to your preferences. Refer to the available [environment variables](/self-hosting/configuration/envars).
```bash ```bash
cp .env.example .env cp .env.example .env

19
docs/getting-started/dashboard/create-account.mdx
View File

@@ -8,24 +8,7 @@ If you're using a self-hosted installation, follow the [setup](/self-hosting/ove
## Infisical Cloud ## Infisical Cloud
**Step 1:** Open [infisical.com](https://infisical.com/) and click on either "Try Infisical for free" or "Start for free" to head to the signup sequence. Open [infisical.com](https://infisical.com/) and click on either "Try Infisical for free" or "Start for free" to complete the signup sequence.
![title](../../images/landing-page.png)
**Step 2:** Fill out the signup sequence.
![signup start](../../images/signup-box.png)
![signup one-time password](../../images/signup-otp.png)
![signup complete account](../../images/signup-complete-account.png)
You'll be prompted to fill out some required fields to set up your account.
| Field | Description |
| ---------- | --------------------------- |
| Email | Enter a valid email address |
| First name | Your first name |
| Last name | Your last name |
| Password | Password |
Once you've done that, you'll be taken to the dashboard where we've populated some default environment variables for demonstration. Once you've done that, you'll be taken to the dashboard where we've populated some default environment variables for demonstration.

10
docs/getting-started/dashboard/integrations.mdx
View File

@@ -2,12 +2,10 @@
title: "Integrations" title: "Integrations"
--- ---
We’re still early with integrations but you’ll be able to sync environment variables across your entire infrastructure from local development to CI/CD and production. Integrations allow environment variables to be synced across your entire infrastructure from local development to CI/CD and production.
We're still early with integrations, but expect more soon.
![integrations](../../images/project-integrations.png) ![integrations](../../images/project-integrations.png)
Check out integrations: Check out our [integrations](/integrations/overview).
- [Heroku](/integrations/heroku)
- [Docker](/integrations/docker)
- [Docker Compose](/integrations/docker-compose)

17
docs/getting-started/dashboard/organization.mdx
View File

@@ -2,15 +2,12 @@
title: "Organization" title: "Organization"
--- ---
By default, Infisical creates an organization under your name such as "John's Organization." To make changes and add members to your organization, head to your organization settings. An organization houses projects and members.
![organization name selected](../../images/dashboard-name-selected.png) By default, Infisical creates an organization under your name. You can manage your organization in your organization settings.
![organization name modal open](../../images/dashboard-name-modal-organization.png) ![organization name modal open](../../images/dashboard-name-modal-organization.png)
![organization name modal open](../../images/organization.png)
![organization page](../../images/organization.png)
Feel free to change the name of your organization.
## Members ## Members
@@ -19,9 +16,12 @@ Members of an organization can create and add other members to projects within t
To add a member to your organization, scroll down to the "Organization Members" section and invite the member via email. They'll receive an email to confirm their organization invitation. If the member is an existing user on the platform, they will be automatically added to the organization. To add a member to your organization, scroll down to the "Organization Members" section and invite the member via email. They'll receive an email to confirm their organization invitation. If the member is an existing user on the platform, they will be automatically added to the organization.
![organization members](../../images/organization-members.png) ![organization members](../../images/organization-members.png)
![organization members add](../../images/organization-members-add.png)
Note that access to projects must be provisioned to new members after they've accepted their invitation, and they will not be added to any projects by default. <Note>
Note that access to projects must be provisioned to new members after they've
accepted their organization invitation, and they will not be added to any
projects by default.
</Note>
## Incident contacts ## Incident contacts
@@ -30,4 +30,3 @@ Incident contacts of an organization are alerted if anything abnormal is detecte
To add an incident contact to your organization, scroll down to the "Incident Contacts" section and add their email. To add an incident contact to your organization, scroll down to the "Incident Contacts" section and add their email.
![organization incident contacts](../../images/organization-ic.png) ![organization incident contacts](../../images/organization-ic.png)
![organization incident contacts add](../../images/organization-ic-add.png)

10
docs/getting-started/dashboard/project.mdx
View File

@@ -2,7 +2,7 @@
title: "Project" title: "Project"
--- ---
A project houses environment variables for an application or service. A project houses environment variables for an application.
## Dashboard ## Dashboard
@@ -33,20 +33,14 @@ Every environment variable is classified as either personal or shared.
You can toggle the classification of an environment variable by pressing on its settings: You can toggle the classification of an environment variable by pressing on its settings:
![project variable toggle](../../images/project-envar-toggle.png)
![project variable toggle open](../../images/project-envar-toggle-open.png) ![project variable toggle open](../../images/project-envar-toggle-open.png)
![project variable toggle moved](../../images/project-envar-toggle-moved.png)
### Search ### Search
You can search for any environment variable by its key. You can search for any environment variable by its key.
![project search](../../images/project-search.png) ![project search](../../images/project-search.png)
![project search typed](../../images/project-search-typed.png)
### Sort ### Sort
You can sort environment variables alphabetically by their keys. You can sort environment variables alphabetically by their keys.
@@ -59,8 +53,6 @@ You can hide or un-hide the values of your environment variables. By default, th
![project hide](../../images/project-hide.png) ![project hide](../../images/project-hide.png)
![project unhide](../../images/project-hide.png)
### Download as .env ### Download as .env
You can download your environment variables back in a .env file. You can download your environment variables back in a .env file.

19
docs/getting-started/dashboard/token.mdx
View File

@@ -2,20 +2,15 @@
title: "Infisical Token" title: "Infisical Token"
--- ---
An Infisical Token is needed to authenticate the CLI when there isn't an easy way to manually type in your login credentials to sync environment variables to your applications. An Infisical Token is needed to authenticate the CLI when there isn't an easy way to input your login credentials.
It grants read-only access to a particular environment and project for a specified amount of time. It's useful for the [Docker](/integrations/docker) and [Docker Compose](/integrations/docker-compose) integrations.
This is useful in the following contexts: It's possible to generate the token in the settings of a project.
- [Docker](/integrations/docker)/[Docker-Compose](/integrations/docker-compose) integration: An Infisical Token can be passed to a Docker container as an environment variable for the CLI to authenticate and pull its corresponding secrets.
## Generate an Infisical Token
It's possible to generate an Infisical token in the settings of a project.
![token add](../../images/project-token-add.png) ![token add](../../images/project-token-add.png)
![token name](../../images/project-token-name.png) <Note>
The token grants read-only access to a particular environment and project for
![token added](../../images/project-token-added.png) a specified amount of time.
</Note>

12
docs/integrations/docker-compose.mdx
View File

@@ -2,11 +2,13 @@
title: "Docker Compose" title: "Docker Compose"
--- ---
### Step 1: Add CLI to your Dockerfile The Docker Compose integration enables you to inject environment variables from Infisical into the containers defined in your compose file.
Follow steps 1 through 3 on our [guide to configure Infisical CLI](../getting-started/cli/installation) in your Dockerfile. ## Add the CLI to your Dockerfile(s)
### Step 2: Generate Infisical Token Follow steps 1 through 3 on our [guide to configure Infisical CLI](../integrations/docker) in your Dockerfile.
## 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.
@@ -16,7 +18,7 @@ To learn how, visit [Infisical Token](../getting-started/cli/infisical-token). O
have to generate a Infisical Token for each service. have to generate a Infisical Token for each service.
</Info> </Info>
### Step 3: Tell Docker Compose your Infisical Token ## 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.
@@ -41,7 +43,7 @@ services:
- INFISICAL_TOKEN=${INFISICAL_TOKEN_FOR_API} - INFISICAL_TOKEN=${INFISICAL_TOKEN_FOR_API}
``` ```
### 4: Export shell variables ## 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.

24
docs/integrations/docker.mdx
View File

@@ -2,7 +2,9 @@
title: "Docker" title: "Docker"
--- ---
## Step 1: Add CLI to your Dockerfile The Docker integration enables you to inject environment variables from Infisical into a container.
## Add the CLI to your Dockerfile
<Tabs> <Tabs>
<Tab title="Alpine"> <Tab title="Alpine">
@@ -29,14 +31,10 @@ title: "Docker"
</Tab> </Tab>
</Tabs> </Tabs>
## Step 2: Generate Infisical Token ## Modify the start command in your Dockerfile
[Generate an Infisical Token](../../getting-started/dashboard/token) and keep it handy.
## Step 3: Set start command of your container
```dockerfile ```dockerfile
CMD ["infisical", "--env=[your-project-env-name]", "projectId=[your-project-id]", "run", "---", "<your application start command>"] CMD ["infisical", "--env=[env]", "projectId=[projectId]", "run", "---", "[your application start command]"]
# example # example
CMD ["infisical", "--env=prod", "projectId=62faf98ae0b05e83239b5da41", "run", "---", "npm run start"] CMD ["infisical", "--env=prod", "projectId=62faf98ae0b05e83239b5da41", "run", "---", "npm run start"]
@@ -49,12 +47,14 @@ Required options:
| `--env` | Used to set the environment that secrets are pulled from. Accepted values: `dev`, `staging`, `test`, `prod` | `dev` | | `--env` | Used to set the environment that secrets are pulled from. Accepted values: `dev`, `staging`, `test`, `prod` | `dev` |
| `--projectId` | Used to link a local project to the platform | `None` | | `--projectId` | Used to link a local project to the platform | `None` |
## Step 4: Feed Docker your Infisical Token ## Generate an Infisical Token
The CLI looks out for an environment variable called the `INFISICAL_TOKEN` which you can set depending on where you run the CLI. If `INFISICAL_TOKEN` is detected by the CLI, it will authenticate and retrieve the environment variables which the token is authorized for. [Generate an Infisical Token](../../getting-started/dashboard/token) and keep it handy.
## Feed Docker your Infisical Token
The CLI looks out for an environment variable called `INFISICAL_TOKEN`. If the token is detected, the CLI will authenticate, retrieve, and inject the environment variables which the token is authorized for.
```bash ```bash
docker run --env INFISICAL_TOKEN=[the-token-you-got-from-step-2]... docker run --env INFISICAL_TOKEN=[token]...
``` ```
Note: `INFISICAL_TOKEN` is the token you generated in step 2.

2
docs/integrations/overview.mdx
View File

@@ -2,7 +2,7 @@
title: "Overview" title: "Overview"
--- ---
Integrations allow environment variables to be synced across your entire infrastructure from local development to CI/CD and production. Integrations allow environment variables to be synced from Infisical into your local development workflow, CI/CD pipelines, and production infrastructure.
Missing an integration? Throw in a [request](https://github.com/Infisical/infisical/issues). Missing an integration? Throw in a [request](https://github.com/Infisical/infisical/issues).

159
docs/mint.json
View File

@@ -27,90 +27,109 @@
"url": "https://app.infisical.com/signup" "url": "https://app.infisical.com/signup"
}, },
"anchors": [ "anchors": [
{
"name": "Security",
"icon": "shield-halved",
"url": "security"
},
{
"name": "Self-hosting",
"icon": "server",
"url": "self-hosting"
},
{
"name": "Contributing",
"icon": "code",
"url": "contributing"
},
{ {
"name": "Blog", "name": "Blog",
"icon": "newspaper", "icon": "newspaper",
"url": "https://blog.infisical.com/" "url": "https://blog.infisical.com/"
},
{
"name": "Slack",
"icon": "slack",
"url": "https://join.slack.com/t/infisical-users/shared_invite/zt-1kovn1q6p-p5fvJo7o083naouDkOzgZQ"
},
{
"name": "GitHub",
"icon": "github",
"url": "https://github.com/Infisical/infisical"
} }
], ],
"navigation": [ "navigation": [
{ {
"group": " ", "group": "Overview",
"pages": [ "pages": [
"getting-started/introduction",
"getting-started/quickstart",
"getting-started/features"
]
},
{
"group": "Platform",
"pages": [
"getting-started/dashboard/organization",
"getting-started/dashboard/project",
"getting-started/dashboard/integrations",
"getting-started/dashboard/token"
]
},
{
"group": "CLI",
"pages": [
"cli/overview",
"cli/usage",
{ {
"group": "Overview", "group": "Reference",
"pages": [ "pages": [
"getting-started/introduction", "cli/reference/commands",
"getting-started/quickstart", "cli/reference/login",
"getting-started/features" "cli/reference/init",
] "cli/reference/run"
},
{
"group": "Security",
"pages": [
"security/overview",
"security/data-model",
"security/mechanics"
]
},
{
"group": "Web UI",
"pages": [
"getting-started/dashboard/create-account",
"getting-started/dashboard/organization",
"getting-started/dashboard/project",
"getting-started/dashboard/integrations",
"getting-started/dashboard/token"
]
},
{
"group": "CLI",
"pages": [
"cli/overview",
"cli/usage",
{
"group": "Reference",
"pages": [
"cli/reference/commands",
"cli/reference/login",
"cli/reference/init",
"cli/reference/run"
]
}
]
},
{
"group": "Integrations",
"pages": [
"integrations/overview",
"integrations/heroku",
"integrations/docker",
"integrations/docker-compose"
]
},
{
"group": "Self-hosting",
"pages": [
"self-hosting/overview",
{
"group": "Deployments",
"pages": ["self-hosting/deployments/linux"]
},
{
"group": "Configuration",
"pages": ["self-hosting/configuration/envars"]
}
]
},
{
"group": "Contributing",
"pages": [
"contributing/overview",
"contributing/code-of-conduct",
"contributing/developing"
] ]
} }
] ]
},
{
"group": "Integrations",
"pages": [
"integrations/overview",
"integrations/heroku",
"integrations/docker",
"integrations/docker-compose"
]
},
{
"group": "Self-hosting",
"pages": [
"self-hosting/overview",
{
"group": "Deployments",
"pages": ["self-hosting/deployments/linux"]
},
{
"group": "Configuration",
"pages": ["self-hosting/configuration/envars"]
}
]
},
{
"group": "Security",
"pages": [
"security/overview",
"security/data-model",
"security/mechanics"
]
},
{
"group": "Contributing",
"pages": [
"contributing/overview",
"contributing/code-of-conduct",
"contributing/developing"
]
} }
], ],
"backgroundImage": "/images/background.png" "backgroundImage": "/images/background.png"

2
docs/self-hosting/deployments/linux.mdx
View File

@@ -51,4 +51,4 @@ nano .env
docker-compose -f docker-compose.yml up -d docker-compose -f docker-compose.yml up -d
``` ```
5. Your Infisical installation is complete and should be running on port 8080. Please note that the containers are not exposed to the internet and only bind to the localhost. It's up to you to configure a firewall, SSL certificates, and implement any additional security measures. 5. Your Infisical installation is complete and should be running on [http://localhost:8080](http://localhost:8080). Please note that the containers are not exposed to the internet and only bind to the localhost. It's up to you to configure a firewall, SSL certificates, and implement any additional security measures.