Skip to content

Commit 83f8838

Browse files
authored
rewrite all the web app docs (#1725)
1 parent f5fb37f commit 83f8838

23 files changed

+197
-122
lines changed
Loading
Loading
Binary file not shown.

content/en/user-guide/web-application/accounts/index.md

+54-9
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,67 @@
22
title: "Accounts"
33
weight: 10
44
description: >
5-
The LocalStack accounts gives users access to the features in the web app like the resource browser, Stack Insight, Cloud pods, extensions and more.
5+
A LocalStack account is required to access features in the Web Application, and to access any of our offerings.
66
---
77

8-
A LocalStack account is required to access features in the web app, and to access any of our paid offerings.
8+
## Introduction
9+
10+
A user account on the LocalStack Web Application is required to access the following features:
11+
12+
- Advanced AWS services
13+
- Resource Browsers
14+
- Cloud Pods
15+
- Extensions Library
16+
- Stack Insights
17+
- Ephemeral Instances
18+
- IAM Policy Stream
19+
- Chaos Engineering
20+
21+
To create an Auth Token for your LocalStack account, you need to sign up for an account on the LocalStack Web Application.
22+
23+
This token is used to authenticate your requests to the LocalStack platform and access the features mentioned above.
924

1025
## Creating an Account
1126

12-
Visit [**app.localstack.cloud/sign-up**](https://app.localstack.cloud/sign-up) to create a user account for LocalStack.
13-
You can sign up with your email address or one of our supported social identity providers (such as GitHub).
27+
You can either:
28+
29+
- Sign up with GitHub, or
30+
- Enter your email address and follow the prompts.
31+
32+
After submitting your email:
33+
34+
1. Select whether you're working on **commercial** or **personal** projects.
35+
2. Fill in your first and last name.
36+
3. (**Optional**) Add company, job title, and GitHub username.
37+
4. Agree to the terms and conditions to continu
38+
.
39+
40+
A verification link will be sent to your email.
41+
Once verified, you can log in using your email or GitHub account.
42+
43+
> Terms: [localstack.cloud/legal/tos](https://www.localstack.cloud/legal/tos)
44+
> Privacy Policy: [localstack.cloud/legal/privacy-policy](https://www.localstack.cloud/legal/privacy-policy)
45+
46+
<img src="account-signup-form.png" width="700px" alt="Account sign-up form" title="Sign-up screen">
47+
48+
## Logging In
49+
50+
Once your account is activated, log in at [**app.localstack.cloud**](https://app.localstack.cloud) using your selected sign-in method.
51+
52+
Supported login options:
53+
- GitHub
54+
- SSO (if configured)
55+
- Email-based authentication
1456

15-
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>
57+
## Updating Account Settings
1658

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

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

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

23-
<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">
68+
Changes are saved automatically once submitted.
Binary file not shown.

content/en/user-guide/web-application/ci-keys/index.md

-16
Original file line numberDiff line numberDiff line change
@@ -32,19 +32,3 @@ These keys are linked to specific CI pipelines or projects, rather than individu
3232

3333
CI Keys are not meant for individual developers.
3434
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).
35-
36-
{{< callout >}}
37-
We have recently introduced Auth Tokens to replace _developer_ API keys.
38-
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.
39-
{{< /callout >}}
40-
41-
## Managing CI keys
42-
43-
To create a new CI key, input a meaningful name in the provided field and click the 'Generate CI Key' button.
44-
For better management, it's advisable to use a distinct CI key for each project or CI pipeline.
45-
You can manage existing CI keys by renaming, rotating, or deleting them through the options available in the list.
46-
47-
The top section of the CI page displays the usage of CI tokens for the current period.
48-
Each period lasts one month, and the token count resets at the beginning of a new period.
49-
The dates for the current period are indicated near the usage graph.
50-
While there's no limit to the number of CI keys a workspace can have, all the keys contribute to the same quota.

content/en/user-guide/web-application/instance-management/index.md

+3
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,12 @@ You can access this feature through the [**LocalStack Instances**](https://app.l
1313

1414
Instance Management offers these features:
1515

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

2124
<img src="instance-management.png" alt="LocalStack Web Application's Instance Management page" title="Instance Management" width="800px" />
Loading

content/en/user-guide/web-application/resource-browser/index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: >
1010
The LocalStack Resource Browser allow you to view, manage, and deploy AWS resources locally while building & testing their cloud applications locally.
1111
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.
1212

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

1515
The Resource Browser provide an experience similar to the AWS Management Console.
1616
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.
@@ -70,6 +70,7 @@ The Resource Browser supports the following AWS services:
7070
| | [Amazon DocumentDB](https://app.localstack.cloud/inst/default/resources/docdb/clusters) |
7171
| | [Amazon Neptune](https://app.localstack.cloud/inst/default/resources/neptune/clusters) |
7272
| | [Amazon Timestream](https://app.localstack.cloud/inst/default/resources/timestream-write) |
73+
| | [Amazon Redshift](https://app.localstack.cloud/inst/default/resources/redshift/clusters) |
7374
| **Analytics** | [Amazon Athena](https://app.localstack.cloud/inst/default/resources/athena/databases) |
7475
| | [Amazon Kinesis](https://app.localstack.cloud/inst/default/resources/kinesis) |
7576
| | [Amazon MSK (Managed Streaming for Kafka)](https://app.localstack.cloud/inst/default/resources/kafka) |
@@ -78,6 +79,7 @@ The Resource Browser supports the following AWS services:
7879
| | [Amazon CloudFront](https://app.localstack.cloud/inst/default/resources/cloudfront/distributions) |
7980
| | [Amazon OpenSearch Service](https://app.localstack.cloud/inst/default/resources/opensearch/domains) |
8081
| **Cloud Financial Management** | [AWS Cost Explorer](https://app.localstack.cloud/inst/default/resources/ce/costcategorydefinitions) |
82+
| **Migration & Transfer** | [Database Migration Service](https://app.localstack.cloud/inst/default/resources/dms/endpoints) |
8183

8284
## Troubleshooting
8385

Loading
Loading

content/en/user-guide/web-application/stack-overview/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The Stack Overview provides a summary of deployed resources, categorized service
1212
You can access the Stack Overview in the [LocalStack Web Application](https://app.localstack.cloud/inst/default/overview).
1313
Alternatively, go to your LocalStack Instance and click on **Overview** to see a high-level visualization of your locally running cloud app architecture.
1414

15-
<img src="stack-overview.png" width="900px" alt="Stack Overview">
15+
<img src="stack-overview.png" width="700px" alt="Stack Overview">
1616
<br>
1717
<br>
1818

Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
title: "Users and Licenses"
3+
weight: 30
4+
description: >
5+
Invite new users and manage a user's license and legacy API key.
6+
aliases:
7+
- /user-guide/web-application/users-and-licenses
8+
---
9+
10+
## Introduction
11+
12+
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.
13+
14+
To access this page:
15+
1. Click on your name in the top-left corner of the dashboard.
16+
2. Go to **Settings****Users & Licenses** under the **Administration** section.
17+
18+
<img src="users-licenses-page.png" width="800px" alt="Users & Licenses management screen" title="Users & Licenses management screen">
19+
20+
## Managing Users
21+
22+
### Inviting Users
23+
24+
To invite someone to your workspace:
25+
26+
- Go to the **Invite User** section.
27+
- Enter the name and email of the user.
28+
- Check the option to automatically assign a license (optional).
29+
- Click **Invite To Workspace**.
30+
31+
If the invitee does not have a LocalStack account, they will receive an email to create one.
32+
33+
The name entered here is only a placeholder until the user completes signup.
34+
35+
{{< callout >}}
36+
Only workspace admins can invite users and manage license assignments.
37+
{{< /callout >}}
38+
39+
<img src="invite-user.png" width="700px" alt="Invite user form" title="Invite user form">
40+
41+
### Removing Users
42+
43+
To remove a user from the workspace:
44+
45+
- Click on the user entry to expand their details.
46+
- Click **Remove User from Workspace**.
47+
48+
You can re-invite them anytime.
49+
50+
### Managing Roles and Permissions
51+
52+
Click on a user’s entry to view and edit their role.
53+
54+
- Set them as **Admin** or **Member**
55+
- Configure advanced permissions if available
56+
57+
## Managing Licenses
58+
59+
Licenses are part of subscription plans and are shown under the **Licenses** section.
60+
61+
- To **assign** a license: Use the dropdown next to a user in the members list.
62+
- To **unassign** a license: Click the `x` on the license badge next to the user.
63+
- A license can be reassigned at any time.
64+
65+
Changes apply immediately and don’t require user action.
66+
67+
## Migrating from Legacy API Keys
68+
69+
Previously, access was granted via personal developer API keys.
70+
71+
### Why move to Auth Tokens?
72+
73+
- Auth Tokens are more secure and rotate-friendly.
74+
- Admins can manage licenses without the user needing to change configurations.
75+
- Users authenticate once with the token; the license is linked automatically.
76+
77+
### Migration Process
78+
79+
1. Go to the **Workspace Members** list.
80+
2. Assign a license to a user.
81+
3. Ask the user to switch their config to use an **Auth Token** (available in the **Auth Tokens** page).
82+
4. Remove the legacy API key once the Auth Token is in use.
83+
84+
{{< callout >}}
85+
If a user has both a legacy API key and a license, it only counts as **one** active license
86+
87+
{{< /callout >}}
88+
89+
### Deprecation Notice
90+
91+
Legacy API keys are still supported for now, but will be phased out over the coming months.
92+
We recommend migrating to licenses and Auth Tokens as soon as possible.
Loading
Loading

content/en/user-guide/web-application/users-licences/index.md

-82
This file was deleted.
Binary file not shown.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: "Workspace"
3+
weight: 20
4+
description: >
5+
A Workspace is the base organizational unit in the LocalStack Web Application.
6+
aliases:
7+
- /user-guide/web-application/workspaces
8+
---
9+
10+
## Introduction
11+
12+
In LocalStack, a **Workspace** is the foundational unit for organizing users, resources, and billing.
13+
14+
It enables collaboration across teams and provides access to shared capabilities.
15+
16+
## Workspace Features
17+
18+
These include:
19+
20+
- **Cloud Pods** : Manage and share your state snapshots.
21+
- **Stack Insights**: Monitor and observe your LocalStack usage.
22+
- **Extensions**: Access the Extensions Library.
23+
24+
You can find these under the **Workspace** section in the left sidebar.
25+
26+
<img src="workspace-features.png" width="200px" alt="User workspace features section in sidebar" title="Workspace features in sidebar">
27+
28+
## Workspace Settings
29+
30+
Workspace settings can be accessed by clicking your or your organization's name in the top-left corner → **Settings****Workspace**.
31+
32+
Here, administrators can configure and manage:
33+
34+
- Workspace name
35+
- Company account status
36+
- Country and Tax ID
37+
- User and license management
38+
- Authentication tokens
39+
- Subscriptions and billing
40+
- Legacy CI/API keys (if applicable)
41+
42+
These options are available under the **Administration** section.
43+
44+
<img src="workspace-admin-settings.png" width="700px" alt="Administration settings for workspace" title="Workspace settings panel">
Loading
Loading

content/en/user-guide/web-application/workspaces/index.md

-13
This file was deleted.
Binary file not shown.

0 commit comments

Comments
 (0)