update docker docs, fix links, add export cmd

This commit is contained in:
Maidul Islam
2022-12-08 19:02:17 -05:00
parent aa218d2ddc
commit 68d51d402a
9 changed files with 16 additions and 13 deletions
@@ -15,7 +15,7 @@ Export environment variables from the platform into a file format.
| Option | Description | Default value | | Option | Description | Default value |
| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| `--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 determine from which infisical project your secrets will be exported from (only required if injecting via the service token method). | `None` | | `--projectId` | Only required if injecting via the [service token method](../token). If you are not using service token, the project id will be automatically retrieved from the `.infisical.json` located at the root of your local project. | `None` |
| `--expand` | Parse shell parameter expansions in your secrets (e.g., `${DOMAIN}`) | `true` | | `--expand` | Parse shell parameter expansions in your secrets (e.g., `${DOMAIN}`) | `true` |
| `--format` | Format of the output file. Accepted values: `dotenv`, `csv` and `json` | `dotenv` | | `--format` | Format of the output file. Accepted values: `dotenv`, `csv` and `json` | `dotenv` |
+1 -1
View File
@@ -1,5 +1,5 @@
--- ---
title: "Overview" title: "Install"
--- ---
Prerequisite: Set up an account with [Infisical Cloud](https://app.infisical.com) or via a [self-hosted installation](/self-hosting/overview). Prerequisite: Set up an account with [Infisical Cloud](https://app.infisical.com) or via a [self-hosted installation](/self-hosting/overview).
+6 -3
View File
@@ -4,13 +4,16 @@ title: "Infisical Token"
An Infisical Token is needed to authenticate the CLI when there isn't an easy way to input your login credentials. An Infisical Token is needed to authenticate the CLI when there isn't an easy way to input your login credentials.
It's useful for the [Docker](/integrations/platforms/docker) and [Docker Compose](/integrations/platforms/docker-compose) integrations. It's useful for your CI/CD environments and integrations such as [Docker](/integrations/platforms/docker) and [Docker Compose](/integrations/platforms/docker-compose).
To generate the the token, head over to your project settings as shown below.
It's possible to generate the token in the settings of a project.
![token add](../../images/project-token-add.png) ![token add](../../images/project-token-add.png)
<Note> <Note>
The token grants read-only access to a particular environment and project for The token grants read-only access to a particular environment and project for
a specified amount of time. a specified amount of time. Once the token is expired, the CLI using it will no longer be able to make
requests with it.
</Note> </Note>
@@ -4,14 +4,14 @@ title: "Docker Compose"
The Docker Compose integration enables you to inject environment variables from Infisical into the containers defined in your compose file. The Docker Compose integration enables you to inject environment variables from Infisical into the containers defined in your compose file.
## Add the CLI to your Dockerfile(s) ## Add the CLI to your Dockerfile(s) start command
Follow steps 1 through 3 on our [guide to configure Infisical CLI](../integrations/platforms/docker) in your Dockerfile. Follow the [guide to configure Infisical CLI](./docker) in your your Dockerfile first.
## Generate Infisical Token ## 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/dashboard/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 If you have multiple services and they do not use the same secrets, you will
+5 -5
View File
@@ -87,12 +87,12 @@
"cli/overview", "cli/overview",
"cli/usage", "cli/usage",
{ {
"group": "Reference", "group": "Commands",
"pages": [ "pages": [
"cli/reference/commands", "cli/commands/login",
"cli/reference/login", "cli/commands/init",
"cli/reference/init", "cli/commands/run",
"cli/reference/run" "cli/commands/export"
] ]
} }
] ]