Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
63 changes: 54 additions & 9 deletions content/en/user-guide/web-application/accounts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,67 @@
title: "Accounts"
weight: 10
description: >
The LocalStack accounts gives users access to the features in the web app like the resource browser, Stack Insight, Cloud pods, extensions and more.
A LocalStack account is required to access features in the Web Application, and to access any of our offerings.
---

A LocalStack account is required to access features in the web app, and to access any of our paid offerings.
## Introduction

A user account on the LocalStack Web Application is required to access the following features:

- Advanced AWS services
- Resource Browsers
- Cloud Pods
- Extensions Library
- Stack Insights
- Ephemeral Instances
- IAM Policy Stream
- Chaos Engineering

To create an Auth Token for your LocalStack account, you need to sign up for an account on the LocalStack Web Application.

This token is used to authenticate your requests to the LocalStack platform and access the features mentioned above.

## Creating an Account

Visit [**app.localstack.cloud/sign-up**](https://app.localstack.cloud/sign-up) to create a user account for LocalStack.
You can sign up with your email address or one of our supported social identity providers (such as GitHub).
You can either:

- Sign up with GitHub, or
- Enter your email address and follow the prompts.

After submitting your email:

1. Select whether you're working on **commercial** or **personal** projects.
2. Fill in your first and last name.
3. (**Optional**) Add company, job title, and GitHub username.
4. Agree to the terms and conditions to continu
.

A verification link will be sent to your email.
Once verified, you can log in using your email or GitHub account.

> Terms: [localstack.cloud/legal/tos](https://www.localstack.cloud/legal/tos)
> Privacy Policy: [localstack.cloud/legal/privacy-policy](https://www.localstack.cloud/legal/privacy-policy)

<img src="account-signup-form.png" width="700px" alt="Account sign-up form" title="Sign-up screen">

## Logging In

Once your account is activated, log in at [**app.localstack.cloud**](https://app.localstack.cloud) using your selected sign-in method.

Supported login options:
- GitHub
- SSO (if configured)
- Email-based authentication

The Terms and Conditions can be found at <a href="https://www.localstack.cloud/legal/tos" target="_blank">https://www.localstack.cloud/legal/tos</a> and our privacy policy can be found at <a href="https://www.localstack.cloud/legal/privacy-policy" target="_blank">https://www.localstack.cloud/legal/privacy-policy</a>
## Updating Account Settings

<img src="signup.PNG" width="550px" alt="A screenshot of the sign up form" title="Sign-up form">
To update your profile or change account settings:

## Updating Account Info and Settings
1. Click your name or organization's name in the top-left corner.
2. Select **Settings** from the dropdown.
3. Navigate to **Profile** to update your name, company, job title, phone number, or GitHub username.

To update your account info, password and settings select the corresponding entry from the sidebar under the 'Account' menu entry.
<img src="account-settings.png" width="700px" alt="Account settings in sidebar" title="Navigating to account settings">
<br><br>

<img src="account.png" alt="A screenshot of the 'Account Information' page with the 'Account' section highlighted in the navigation sidebar on the left." title="Account Settings" width="900">
Changes are saved automatically once submitted.
Binary file not shown.
16 changes: 0 additions & 16 deletions content/en/user-guide/web-application/ci-keys/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,3 @@ These keys are linked to specific CI pipelines or projects, rather than individu

CI Keys are not meant for individual developers.
To grant a developer access to LocalStack and its advanced features, assign a license to them on the [Users & Licenses page](https://app.localstack.cloud/workspace/members).

{{< callout >}}
We have recently introduced Auth Tokens to replace _developer_ API keys.
However, this change does not affect **CI Keys**, which remain the sole method for activating a LocalStack instance in Continuous Integration (CI) or other automated test environments.
{{< /callout >}}

## Managing CI keys

To create a new CI key, input a meaningful name in the provided field and click the 'Generate CI Key' button.
For better management, it's advisable to use a distinct CI key for each project or CI pipeline.
You can manage existing CI keys by renaming, rotating, or deleting them through the options available in the list.

The top section of the CI page displays the usage of CI tokens for the current period.
Each period lasts one month, and the token count resets at the beginning of a new period.
The dates for the current period are indicated near the usage graph.
While there's no limit to the number of CI keys a workspace can have, all the keys contribute to the same quota.
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,12 @@ You can access this feature through the [**LocalStack Instances**](https://app.l

Instance Management offers these features:

- **Overview**: Shows the stack details of your LocalStack instances.
- **Status**: Shows the status of the services running in the LocalStack container.
- **Resource Browser**: Lets you view and manage your local AWS resources.
- **State**: Allows you to export and import the state of your LocalStack instances.
- **IAM Policy Stream**: Provides a stream of IAM policies corresponding to the AWS API calls.
- **Chaos Engineering**: Allows you to inject failures & simulate outages in your LocalStack instance.
- **Extensions**: Provides extra integrations to improve your LocalStack experience.

<img src="instance-management.png" alt="LocalStack Web Application's Instance Management page" title="Instance Management" width="800px" />
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: >
The LocalStack Resource Browser allow you to view, manage, and deploy AWS resources locally while building & testing their cloud applications locally.
It provides an internal, integrated experience, similar to the AWS Management Console, to manage the ephemeral resources in a LocalStack container on your local machine.

<img src="resource-browser.png" alt="LocalStack Web Application's Resource Browsers outlining various local AWS services" title="Resource Browser" width="900" />
<img src="resource-browser.png" alt="LocalStack Web Application's Resource Browsers outlining various local AWS services" title="Resource Browser" width="700px" />

The Resource Browser provide an experience similar to the AWS Management Console.
However, the Resource Browser is not a replacement for the AWS Management Console and only replicate some of the features of the AWS Management Console.
Expand Down Expand Up @@ -70,6 +70,7 @@ The Resource Browser supports the following AWS services:
| | [Amazon DocumentDB](https://app.localstack.cloud/inst/default/resources/docdb/clusters) |
| | [Amazon Neptune](https://app.localstack.cloud/inst/default/resources/neptune/clusters) |
| | [Amazon Timestream](https://app.localstack.cloud/inst/default/resources/timestream-write) |
| | [Amazon Redshift](https://app.localstack.cloud/inst/default/resources/redshift/clusters) |
| **Analytics** | [Amazon Athena](https://app.localstack.cloud/inst/default/resources/athena/databases) |
| | [Amazon Kinesis](https://app.localstack.cloud/inst/default/resources/kinesis) |
| | [Amazon MSK (Managed Streaming for Kafka)](https://app.localstack.cloud/inst/default/resources/kafka) |
Expand All @@ -78,6 +79,7 @@ The Resource Browser supports the following AWS services:
| | [Amazon CloudFront](https://app.localstack.cloud/inst/default/resources/cloudfront/distributions) |
| | [Amazon OpenSearch Service](https://app.localstack.cloud/inst/default/resources/opensearch/domains) |
| **Cloud Financial Management** | [AWS Cost Explorer](https://app.localstack.cloud/inst/default/resources/ce/costcategorydefinitions) |
| **Migration & Transfer** | [Database Migration Service](https://app.localstack.cloud/inst/default/resources/dms/endpoints) |

## Troubleshooting

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The Stack Overview provides a summary of deployed resources, categorized service
You can access the Stack Overview in the [LocalStack Web Application](https://app.localstack.cloud/inst/default/overview).
Alternatively, go to your LocalStack Instance and click on **Overview** to see a high-level visualization of your locally running cloud app architecture.

<img src="stack-overview.png" width="900px" alt="Stack Overview">
<img src="stack-overview.png" width="700px" alt="Stack Overview">
<br>
<br>

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
92 changes: 92 additions & 0 deletions content/en/user-guide/web-application/users-and-licenses/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
---
title: "Users and Licenses"
weight: 30
description: >
Invite new users and manage a user's license and legacy API key.
aliases:
- /user-guide/web-application/users-and-licenses
---

## Introduction

The **Users & Licenses** page in the LocalStack Web Application allows workspace administrators to manage user memberships, assign licenses, and transition users from legacy API keys to the new license system.

To access this page:
1. Click on your name in the top-left corner of the dashboard.
2. Go to **Settings** → **Users & Licenses** under the **Administration** section.

<img src="users-licenses-page.png" width="800px" alt="Users & Licenses management screen" title="Users & Licenses management screen">

## Managing Users

### Inviting Users

To invite someone to your workspace:

- Go to the **Invite User** section.
- Enter the name and email of the user.
- Check the option to automatically assign a license (optional).
- Click **Invite To Workspace**.

If the invitee does not have a LocalStack account, they will receive an email to create one.

The name entered here is only a placeholder until the user completes signup.

{{< callout >}}
Only workspace admins can invite users and manage license assignments.
{{< /callout >}}

<img src="invite-user.png" width="700px" alt="Invite user form" title="Invite user form">

### Removing Users

To remove a user from the workspace:

- Click on the user entry to expand their details.
- Click **Remove User from Workspace**.

You can re-invite them anytime.

### Managing Roles and Permissions

Click on a user’s entry to view and edit their role.

- Set them as **Admin** or **Member**
- Configure advanced permissions if available

## Managing Licenses

Licenses are part of subscription plans and are shown under the **Licenses** section.

- To **assign** a license: Use the dropdown next to a user in the members list.
- To **unassign** a license: Click the `x` on the license badge next to the user.
- A license can be reassigned at any time.

Changes apply immediately and don’t require user action.

## Migrating from Legacy API Keys

Previously, access was granted via personal developer API keys.

### Why move to Auth Tokens?

- Auth Tokens are more secure and rotate-friendly.
- Admins can manage licenses without the user needing to change configurations.
- Users authenticate once with the token; the license is linked automatically.

### Migration Process

1. Go to the **Workspace Members** list.
2. Assign a license to a user.
3. Ask the user to switch their config to use an **Auth Token** (available in the **Auth Tokens** page).
4. Remove the legacy API key once the Auth Token is in use.

{{< callout >}}
If a user has both a legacy API key and a license, it only counts as **one** active license

{{< /callout >}}

### Deprecation Notice

Legacy API keys are still supported for now, but will be phased out over the coming months.
We recommend migrating to licenses and Auth Tokens as soon as possible.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
82 changes: 0 additions & 82 deletions content/en/user-guide/web-application/users-licences/index.md

This file was deleted.

Binary file not shown.
44 changes: 44 additions & 0 deletions content/en/user-guide/web-application/workspace/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: "Workspace"
weight: 20
description: >
A Workspace is the base organizational unit in the LocalStack Web Application.
aliases:
- /user-guide/web-application/workspaces
---

## Introduction

In LocalStack, a **Workspace** is the foundational unit for organizing users, resources, and billing.

It enables collaboration across teams and provides access to shared capabilities.

## Workspace Features

These include:

- **Cloud Pods** : Manage and share your state snapshots.
- **Stack Insights**: Monitor and observe your LocalStack usage.
- **Extensions**: Access the Extensions Library.

You can find these under the **Workspace** section in the left sidebar.

<img src="workspace-features.png" width="200px" alt="User workspace features section in sidebar" title="Workspace features in sidebar">

## Workspace Settings

Workspace settings can be accessed by clicking your or your organization's name in the top-left corner → **Settings** → **Workspace**.

Here, administrators can configure and manage:

- Workspace name
- Company account status
- Country and Tax ID
- User and license management
- Authentication tokens
- Subscriptions and billing
- Legacy CI/API keys (if applicable)

These options are available under the **Administration** section.

<img src="workspace-admin-settings.png" width="700px" alt="Administration settings for workspace" title="Workspace settings panel">
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 0 additions & 13 deletions content/en/user-guide/web-application/workspaces/index.md

This file was deleted.

Binary file not shown.