Skip to content

Commit

Permalink
update docker docs, fix links, add export cmd
Browse files Browse the repository at this point in the history
  • Loading branch information
maidul98 committed Dec 9, 2022
1 parent aa218d2 commit 68d51d4
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 13 deletions.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/cli/export.mdx → docs/cli/commands/export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Export environment variables from the platform into a file format.
| Option | Description | Default value |
| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| `--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` |
| `--format` | Format of the output file. Accepted values: `dotenv`, `csv` and `json` | `dotenv` |

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/cli/overview.mdx
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
9 changes: 6 additions & 3 deletions docs/getting-started/dashboard/token.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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)

<Note>
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>

6 changes: 3 additions & 3 deletions docs/integrations/platforms/docker-compose.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

## 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

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>
If you have multiple services and they do not use the same secrets, you will
Expand Down
10 changes: 5 additions & 5 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -87,12 +87,12 @@
"cli/overview",
"cli/usage",
{
"group": "Reference",
"group": "Commands",
"pages": [
"cli/reference/commands",
"cli/reference/login",
"cli/reference/init",
"cli/reference/run"
"cli/commands/login",
"cli/commands/init",
"cli/commands/run",
"cli/commands/export"
]
}
]
Expand Down

0 comments on commit 68d51d4

Please sign in to comment.