-
Notifications
You must be signed in to change notification settings - Fork 114
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,23 +2,23 @@ | |
title: "Auth Token" | ||
weight: 20 | ||
description: > | ||
Configure your auth token to access and activate LocalStack. | ||
Configure your Auth Token to access and activate LocalStack. | ||
--- | ||
### Introduction | ||
|
||
Auth tokens allow you to activate the LocalStack emulator and are also used access your workspace and additional services like Cloud Pods. | ||
|
||
Auth tokens exist in 2 varieties. | ||
A **personal developer auth token** and a **CI auth token:** | ||
A **personal developer Auth Token** and a **CI Auth Token:** | ||
|
||
- The **developer auth token** is closely associated with a specific user in a specific workspace. | ||
Every user has an auth token. | ||
- The **developer Auth Token** is closely associated with a specific user in a specific workspace. | ||
Every user has an Auth Token. | ||
It can not be deleted, but it can be rotated for security purposes if required. | ||
It can be found on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens) | ||
|
||
- The **CI auth token** is not tied to a specific user and is intended for use in CI environments and other non developer related contexts. | ||
CI auth tokens live in the workspace, and can be managed by members with the necessary permissions. | ||
CI auth tokens can also be managed on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens) | ||
- The **CI Auth Token** is not tied to a specific user and is intended for use in CI environments and other non developer related contexts. | ||
CI Auth Tokens live in the workspace, and can be managed by members with the necessary permissions. | ||
CI Auth Tokens can also be managed on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens) | ||
|
||
{{< callout "warning">}} | ||
- It's crucial to keep your Auth Token confidential. | ||
|
@@ -29,10 +29,10 @@ A **personal developer auth token** and a **CI auth token:** | |
|
||
## Activating LocalStack | ||
|
||
To activate LocalStack Pro and to access additional services, simply set the auth token in the `LOCALSTACK_AUTH_TOKEN` environment variable. | ||
To activate LocalStack Pro and to access additional services, simply set the Auth Token in the `LOCALSTACK_AUTH_TOKEN` environment variable. | ||
This will make it also available to Docker/Docker Compose setups. | ||
|
||
If you are only starting the LocalStack instance via the LocalStack CLI with `localstack start` then you can configure the auth token with `localstack auth set-token <YOUR_AUTH_TOKEN>`. | ||
If you are only starting the LocalStack instance via the LocalStack CLI with `localstack start` then you can configure the Auth Token with `localstack auth set-token <YOUR_AUTH_TOKEN>`. | ||
|
||
### Managing your License | ||
|
||
|
@@ -45,14 +45,14 @@ After starting your trial or subscribing to a plan, you can manage the license a | |
|
||
## Configuring CI environments | ||
|
||
CI environments are also configured the same way but **require the use of a CI auth token**. A developer auth token can not be used in CI. | ||
CI auth tokens can also be found on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens) page and are configured similarly to develop auth tokens. | ||
CI environments are also configured the same way but **require the use of a CI Auth Token**. A developer Auth Token can not be used in CI. | ||
Check failure on line 48 in content/en/getting-started/auth-token/index.md GitHub Actions / Markdown LintMax 1 sentence should be on a line
Check failure on line 48 in content/en/getting-started/auth-token/index.md GitHub Actions / Markdown LintMax 1 sentence should be on a line
|
||
CI Auth Tokens can also be found on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens) page and are configured similarly to develop Auth Tokens. | ||
|
||
## Activating older versions of localstack ( < v3.0) | ||
|
||
Before auth tokens were introduced, _API keys_ and the `LOCALSTACK_API_KEY` environment variable were used. | ||
Before Auth Tokens were introduced, _API keys_ and the `LOCALSTACK_API_KEY` environment variable were used. | ||
|
||
To allow backwards compatibility with the new auth tokens, we updated our back-end so that a new auth token can be used inside the `LOCALSTACK_API_KEY` variable. Just use the new auth token and configure it as you did with the API key in the past. | ||
To allow backwards compatibility with the new Auth Tokens, we updated our back-end so that a new Auth Token can be used inside the `LOCALSTACK_API_KEY` variable. Just use the new Auth Token and configure it as you did with the API key in the past. | ||
Check failure on line 55 in content/en/getting-started/auth-token/index.md GitHub Actions / Markdown LintMax 1 sentence should be on a line
Check failure on line 55 in content/en/getting-started/auth-token/index.md GitHub Actions / Markdown LintMax 1 sentence should be on a line
|
||
|
||
### Sunsetting legacy API keys (early 2025) | ||
|
||
|
@@ -62,6 +62,6 @@ After the sunsetting period, it will not be able to activate and use legacy API | |
During the sunsetting period, the legacy service will undergo scheduled downtimes. | ||
This schedule will be designed to encourage the transition, but to limit the impact on users if they were not able to update yet. | ||
|
||
The schedule will be communicated in advance, giving users enough time to make the switch to the new auth tokens. | ||
The schedule will be communicated in advance, giving users enough time to make the switch to the new Auth Tokens. | ||
|
||
|
||
Check failure on line 67 in content/en/getting-started/auth-token/index.md GitHub Actions / Markdown LintMultiple consecutive blank lines
Check failure on line 67 in content/en/getting-started/auth-token/index.md GitHub Actions / Markdown LintMultiple consecutive blank lines
|