File tree

126 files changed

+218
-212
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searcx below for content that may be hidden.

126 files changed

+218
-212
lines changed
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,14 @@ Please follow these best practices when writing documentation in this repository
8888
If needed, you can also [highlight a specific line](https://gohugo.io/content-management/syntax-highlighting/#highlighting-in-code-fences).
8989
- **Internal links:** Use the [`ref` or `relref` shortcode](https://gohugo.io/content-management/cross-references/#use-ref-and-relref) when creating non-external links (but still use the markdown native image linking, ref doesn't work there).
9090
You can either use `ref` or `relref`, the point is to have compile time internal-link checks (which works for both).
91+
92+
```text
93+
# Do this
94+
Configuration options are [here]({{< ref "/references/configuration" >}})
95+
96+
# Don't do this
97+
Configuration options are [here](https://docs.localstack.cloud/references/configuration/)
98+
```
9199
- **Code snippets:** For snippets, make sure you indicate the programming/markup language so that proper syntax highlighting is used.
92100
Use `bash` only for Bash scripts, and use `text` for shell outputs or command examples.
93101
The full list of the supported languages [here](https://gohugo.io/content-management/syntax-highlighting/).
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ You have the option to run your LocalStack container in the background by append
9797
The `localstack` CLI automatically detects the Auth Token and appropriately conveys it to the LocalStack container.
9898

9999
{{< callout "note" >}}
100-
If you are using LocalStack with an Auth Token, it's necessary to download the [LocalStack Pro image](https://docs.localstack.cloud/references/docker-images/#localstack-pro-image), which includes Pro services and several advanced features.
100+
If you are using LocalStack with an Auth Token, it's necessary to download the [LocalStack Pro image]({{< ref "/references/docker-images/#localstack-pro-image" >}}), which includes Pro services and several advanced features.
101101
{{< /callout >}}
102102

103103
### Docker
@@ -113,7 +113,7 @@ $ docker run \
113113
localstack/localstack-pro
114114
{{< / command >}}
115115

116-
For more information about starting LocalStack with Docker, take a look at our [Docker installation](https://docs.localstack.cloud/getting-started/installation/#docker) guide.
116+
For more information about starting LocalStack with Docker, take a look at our [Docker installation]({{< ref "/getting-started/installation/#docker" >}}) guide.
117117

118118
### Docker Compose
119119

@@ -134,7 +134,7 @@ Developer Auth Tokens cannot be used in CI.
134134
CI Auth Tokens are available on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens) and are configured similarly to Developer Auth Tokens.
135135

136136
To set the CI Auth Token, add the Auth Token value in the `LOCALSTACK_AUTH_TOKEN` environment variable of your CI provider, and refer to it when starting LocalStack in your CI workflow.
137-
You can find detailed examples in our [LocalStack in CI documentation](https://docs.localstack.cloud/user-guide/ci/).
137+
You can find detailed examples in our [LocalStack in CI documentation]({{< ref "/user-guide/ci/" >}}).
138138

139139
## Rotating the Auth Token
140140

@@ -150,7 +150,7 @@ To rotate your Auth Token, go to the [Auth Token page](https://app.localstack.cl
150150
## Licensing configuration & activation checkup
151151

152152
To avoid logging any licensing-related error messages, set `LOG_LICENSE_ISSUES=0` in your environment.
153-
Refer to our [configuration guide](https://docs.localstack.cloud/references/configuration/#localstack-pro) for more information.
153+
Refer to our [configuration guide]({{< ref "/references/configuration/#localstack-pro" >}}) for more information.
154154

155155
The simplest method to verify if LocalStack is active is by querying the health endpoint for a list of running services:
156156

Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To resolve the issue follow the steps:
1818
This can be done by deleting the cached certificate file.
1919
For example, on Linux systems, you can locate and remove the file at `~/.cache/localstack/volume/cache/server.test.pem`.
2020
The exact path may differ depending on your operating system and how you’ve started LocalStack.
21-
Please refer to our [documentation](https://docs.localstack.cloud/references/filesystem/#localstack-volume) for specific instructions.
21+
Please refer to our [documentation]({{< ref "filesystem/#localstack-volume" >}}) for specific instructions.
2222

2323
**Workarounds for older (<v3.7.0) LocalStack versions:**
2424

Original file line numberDiff line numberDiff line change
@@ -31,22 +31,22 @@ At the moment, we only provide support in `English`, as we are an international
3131

3232
## Support Coverage
3333

34-
| Plan | Tier |
35-
| ---------- | ------------------------------------------------------------------------------------------------------------ |
36-
| Free | [**Basic Support**](https://docs.localstack.cloud/getting-started/help-and-support/#basic-support) |
37-
| Trial | [**Standard Support**](https://docs.localstack.cloud/getting-started/help-and-support/#standard-support) |
38-
| Base | [**Standard Support**](https://docs.localstack.cloud/getting-started/help-and-support/#standard-support) |
39-
| Ultimate | [**Priority Support**](https://docs.localstack.cloud/getting-started/help-and-support/#priority-support) |
40-
| Enterprise | [**Enterprise Support**](https://docs.localstack.cloud/getting-started/help-and-support/#enterprise-support) |
34+
| Plan | Tier |
35+
| ---------- | --------------------------------------------------------------------------------------------- |
36+
| Free | [**Basic Support**]({{< ref "/getting-started/help-and-support/#basic-support" >}}) |
37+
| Trial | [**Standard Support**]({{< ref "/getting-started/help-and-support/#standard-support" >}}) |
38+
| Base | [**Standard Support**]({{< ref "/getting-started/help-and-support/#standard-support" >}}) |
39+
| Ultimate | [**Priority Support**]({{< ref "/getting-started/help-and-support/#priority-support" >}}) |
40+
| Enterprise | [**Enterprise Support**]({{< ref "/getting-started/help-and-support/#enterprise-support" >}}) |
4141

4242
## Support Coverage for legacy plans
4343

44-
| Plan | Tier |
45-
| ---------- | ------------------------------------------------------------------------------------------------------------ |
46-
| Hobby | [**Basic Support**](https://docs.localstack.cloud/getting-started/help-and-support/#basic-support) |
47-
| Starter | [**Standard Support**](https://docs.localstack.cloud/getting-started/help-and-support/#standard-support) |
48-
| Teams | [**Priority Support**](https://docs.localstack.cloud/getting-started/help-and-support/#priority-support) |
49-
| Enterprise | [**Enterprise Support**](https://docs.localstack.cloud/getting-started/help-and-support/#enterprise-support) |
44+
| Plan | Tier |
45+
| ---------- | --------------------------------------------------------------------------------------------- |
46+
| Hobby | [**Basic Support**]({{< ref "/getting-started/help-and-support/#basic-support" >}}) |
47+
| Starter | [**Standard Support**]({{< ref "/getting-started/help-and-support/#standard-support" >}}) |
48+
| Teams | [**Priority Support**]({{< ref "/getting-started/help-and-support/#priority-support" >}}) |
49+
| Enterprise | [**Enterprise Support**]({{< ref "/getting-started/help-and-support/#enterprise-support" >}}) |
5050

5151
## Support features
5252

Original file line numberDiff line numberDiff line change
@@ -449,7 +449,7 @@ $ python3 -m localstack.cli.main
449449
#### The `localstack` CLI does not start the LocalStack container
450450

451451
If you are using the `localstack` CLI to start LocalStack, but the container is not starting, please check the following:
452-
- Uncheck the **Use kernel networking for UDP** option in Docker Desktop (**Settings****Resources****Network**) or follow the steps in our [documentation](https://docs.localstack.cloud/user-guide/tools/dns-server/#system-dns-configuration) to disable it.
452+
- Uncheck the **Use kernel networking for UDP** option in Docker Desktop (**Settings****Resources****Network**) or follow the steps in our [documentation]({{< ref "dns-server/#system-dns-configuration" >}}) to disable it.
453453
- Start LocalStack with a specific DNS address:
454454
{{< command >}}
455455
$ DNS_ADDRESS=0 localstack start
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ An internal SES LocalStack testing endpoint (`/_localstack/aws/ses`) is configur
4141

4242
## Prerequisites
4343

44-
- [LocalStack CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli)
45-
- [LocalStack Web Application account](https://app.localstack.cloud/sign-up) & [Auth Token](https://docs.localstack.cloud/getting-started/auth-token/)
44+
- [LocalStack CLI]({{< ref "/getting-started/installation/#localstack-cli" >}})
45+
- [LocalStack Web Application account](https://app.localstack.cloud/sign-up) & [Auth Token]({{< ref "/getting-started/auth-token/" >}})
4646
- [Docker](https://docs.docker.com/get-docker/)
4747
- [Python 3.11+](https://www.python.org/downloads/) & `pip`
48-
- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) & [`awslocal` wrapper](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal)
48+
- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) & [`awslocal` wrapper]({{< ref "/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal" >}})
4949
- `jq`, `zip` & `curl`
5050

5151
You can start LocalStack using the `localstack` CLI.
@@ -105,7 +105,7 @@ $ pyenv global 3.11
105105

106106
### Setup the serverless image resizer
107107

108-
This application enables serverless image resizing using [S3](https://docs.localstack.cloud/user-guide/aws/s3/), [SSM](https://docs.localstack.cloud/user-guide/aws/ssm/), [Lambda](https://docs.localstack.cloud/user-guide/aws/lambda/), [SNS](https://docs.localstack.cloud/user-guide/aws/sns/), and [SES](https://docs.localstack.cloud/user-guide/aws/ses/).
108+
This application enables serverless image resizing using [S3]({{< ref "/user-guide/aws/s3/" >}}), [SSM]({{< ref "/user-guide/aws/ssm" >}}/), [Lambda]({{< ref "/user-guide/aws/lambda" >}}/), [SNS]({{< ref "/user-guide/aws/sns" >}}/), and [SES]({{< ref "/user-guide/aws/ses" >}}/).
109109
A simple web interface allows users to upload and view resized images.
110110
A Lambda function generates S3 pre-signed URLs for direct uploads, while S3 bucket notifications trigger image resizing.
111111
Another Lambda function lists and provides pre-signed URLs for browser display.
@@ -128,7 +128,7 @@ $ deployment/awslocal/deploy.sh
128128
Alternatively, you can follow these instructions to deploy the sample application manually step-by-step.
129129

130130
{{< callout "tip" >}}
131-
In absence of the `awslocal` wrapper, you can use the `aws` CLI directly, by configuring an [endpoint URL](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#configuring-an-endpoint-url) or a [custom profile](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#configuring-a-custom-profile) like `localstack`.
131+
In absence of the `awslocal` wrapper, you can use the `aws` CLI directly, by configuring an [endpoint URL]({{< ref "/user-guide/integrations/aws-cli/#configuring-an-endpoint-url" >}}) or a [custom profile]({{< ref "/user-guide/integrations/aws-cli/#configuring-a-custom-profile" >}}) like `localstack`.
132132
You can then swap `awslocal` with `aws --endpoint-url=http://localhost:4566` or `aws --profile=localstack` in the commands below.
133133
{{< /callout >}}
134134

Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ You can optionally run your LocalStack container in background mode by adding th
5151
The `localstack` CLI will detect the API key and properly pass it to the LocalStack container.
5252

5353
{{< callout >}}
54-
If you are using LocalStack with an API Key, you need to pull the [LocalStack Pro image](https://docs.localstack.cloud/references/docker-images/#localstack-pro-image) that includes the Pro services and several other advanced features.
54+
If you are using LocalStack with an API Key, you need to pull the [LocalStack Pro image]({{< ref "docker-images/#localstack-pro-image" >}}) that includes the Pro services and several other advanced features.
5555
{{< /callout >}}
5656

5757
### Starting LocalStack via Docker
@@ -67,7 +67,7 @@ $ docker run \
6767
localstack/localstack-pro
6868
{{< / command >}}
6969

70-
For more information about starting LocalStack with Docker, take a look at our [Docker installation](https://docs.localstack.cloud/getting-started/installation/#docker) guide.
70+
For more information about starting LocalStack with Docker, take a look at our [Docker installation]({{< ref "installation/#docker" >}}) guide.
7171

7272
### Starting LocalStack via Docker-Compose
7373

Original file line numberDiff line numberDiff line change
@@ -332,8 +332,8 @@ Please consult the [migration guide]({{< ref "user-guide/aws/lambda#migrating-to
332332
| - | - | - |
333333
| `SQS_DELAY_PURGE_RETRY` | `0` (default) | Used to toggle PurgeQueueInProgress errors when making more than one PurgeQueue call within 60 seconds. |
334334
| `SQS_DELAY_RECENTLY_DELETED` | `0` (default) | Used to toggle QueueDeletedRecently errors when re-creating a queue within 60 seconds of deleting it. |
335-
| `SQS_ENABLE_MESSAGE_RETENTION_PERIOD`| `0` (default) \| `1` | Used to toggle the MessageRetentionPeriod feature (see [Enabling `MessageRetentionPeriod`](https://docs.localstack.cloud/user-guide/aws/sqs/#enabling-messageretentionperiod) |
336-
| `SQS_ENDPOINT_STRATEGY`| `standard` (default) \| `domain` \| `path` \| `off` | Configures the format of Queue URLs (see [SQS Queue URLs](https://docs.localstack.cloud/user-guide/aws/sqs/#queue-urls) |
335+
| `SQS_ENABLE_MESSAGE_RETENTION_PERIOD`| `0` (default) \| `1` | Used to toggle the MessageRetentionPeriod feature (see [Enabling `MessageRetentionPeriod`]({{< ref "sqs/#enabling-messageretentionperiod" >}}) |
336+
| `SQS_ENDPOINT_STRATEGY`| `standard` (default) \| `domain` \| `path` \| `off` | Configures the format of Queue URLs (see [SQS Queue URLs]({{< ref "sqs/#queue-urls" >}}) |
337337
| `SQS_DISABLE_CLOUDWATCH_METRICS` | `0` (default) | Disables the CloudWatch Metrics for SQS when set to `1` |
338338
| `SQS_CLOUDWATCH_METRICS_REPORT_INTERVAL` | `60` (default) | Configures the report interval (in seconds) for `Approximate*` metrics that are sent to CloudWatch periodically. Sending will be disabled if `SQS_DISABLE_CLOUDWATCH_METRICS=1` |
339339

@@ -501,9 +501,9 @@ These configurations have already been removed and **won't have any effect** on
501501
| `DATA_DIR`| 2.0.0 | blank (disabled/default), `/tmp/localstack/data` | Local directory for saving persistent data. Use `PERSISTENCE` instead. |
502502
| `DISABLE_TERM_HANDLER` | 2.0.0 | `""` (default) \| `1` | Whether to disable signal passing to LocalStack when running in docker. Enabling this will prevent an orderly shutdown when running inside LS in docker. Setting this to anything else than an empty string will disable it.
503503
| `HOST_TMP_FOLDER` | 2.0.0 | `/some/path` | Temporary folder on the host that gets mounted as `$TMPDIR/localstack` into the LocalStack container. Required only for Lambda volume mounts when using `LAMBDA_REMOTE_DOCKER=false.` |
504-
| `INIT_SCRIPTS_PATH` | 2.0.0 | `/some/path` | Before 1.0, this was used to configure the path to the initializing files with extensions `.sh` that were found in `/docker-entrypoint-initaws.d`. This has been replaced by the [init-hook system](https://docs.localstack.cloud/references/init-hooks/). |
504+
| `INIT_SCRIPTS_PATH` | 2.0.0 | `/some/path` | Before 1.0, this was used to configure the path to the initializing files with extensions `.sh` that were found in `/docker-entrypoint-initaws.d`. This has been replaced by the [init-hook system]({{< ref "init-hooks" >}}). |
505505
| `LEGACY_DIRECTORIES` | 2.0.0 | `0` (default) | Use legacy method of managing internal filesystem layout. See [Filesystem Layout]({{< ref "filesystem" >}}). |
506-
| `LEGACY_INIT_DIR` | 2.0.0 | `1` \| `0`(default) | Used with `INIT_SCRIPTS_PATH`. This has been replaced by the [init-hook system](https://docs.localstack.cloud/references/init-hooks/). |
506+
| `LEGACY_INIT_DIR` | 2.0.0 | `1` \| `0`(default) | Used with `INIT_SCRIPTS_PATH`. This has been replaced by the [init-hook system]({{< ref "init-hooks" >}}). |
507507
| `MULTI_ACCOUNTS` | 2.0.0 | `0` (default) | Enable multi-accounts (preview) |
508508
| `SQS_PROVIDER` | 2.0.0 | `moto` (default) and `elasticmq` | |
509509
| `SYNCHRONOUS_API_GATEWAY_EVENTS` | 2.0.0 | `1` (default) \| `0` | Whether or not to handle API Gateway Lambda event sources as synchronous invocations. |
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ $ docker pull localstack/localstack:latest
2424

2525
To use the LocalStack Community image, you don't need to sign-up for an account on [LocalStack Web Application](https://app.localstack.cloud).
2626
The Community image is free to use and does not require a license to run.
27-
The Community image can be used to run [local AWS services](https://docs.localstack.cloud/user-guide/aws/) with [integrations](https://docs.localstack.cloud/user-guide/integrations/) on your local machine or in your [continuous integration pipelines](https://docs.localstack.cloud/user-guide/ci/).
27+
The Community image can be used to run [local AWS services]({{< ref "user-guide/aws" >}}) with [integrations]({{< ref "/user-guide/integrations" >}}) on your local machine or in your [continuous integration pipelines]({{< ref "/user-guide/ci" >}}).
2828

29-
The Community image also covers a limited set of [LocalStack Tools](https://docs.localstack.cloud/user-guide/tools/) to make your life as a cloud developer easier.
30-
You can use [LocalStack Desktop](https://docs.localstack.cloud/user-guide/tools/localstack-desktop/) or [LocalStack Docker Extension](https://docs.localstack.cloud/user-guide/tools/localstack-docker-extension/) to use LocalStack with a graphical user interface.
29+
The Community image also covers a limited set of [LocalStack Tools]({{< ref "/user-guide/tools" >}}) to make your life as a cloud developer easier.
30+
You can use [LocalStack Desktop]({{< ref "/user-guide/tools/localstack-desktop/" >}}) or [LocalStack Docker Extension]({{< ref "/user-guide/tools/localstack-docker-extension/" >}}) to use LocalStack with a graphical user interface.
3131

32-
You can use the Community image to start your LocalStack container using various [installation methods](https://docs.localstack.cloud/getting-started/installation/).
32+
You can use the Community image to start your LocalStack container using various [installation methods]({{< ref "/getting-started/installation/" >}}).
3333
While configuring to run LocalStack with Docker or Docker Compose, run the `localstack/localstack` image with the appropriate tag you have pulled (if not `latest`).
3434

3535
## LocalStack Pro image
@@ -44,9 +44,9 @@ $ docker pull localstack/localstack-pro:latest
4444

4545
To use the LocalStack Pro image, you must configure an environment variable named `LOCALSTACK_AUTH_TOKEN` to contain your Auth Token.
4646
The LocalStack Pro image will display a warning if you do not set an Auth Token (or if the license is invalid/expired) and will not activate the Pro features.
47-
LocalStack Pro gives you access to the complete set of LocalStack features, including the [LocalStack Web Application](https://app.localstack.cloud) and [dedicated customer support](https://docs.localstack.cloud/getting-started/help-and-support/#pro-support).
47+
LocalStack Pro gives you access to the complete set of LocalStack features, including the [LocalStack Web Application](https://app.localstack.cloud) and [dedicated customer support]({{< ref "/getting-started/help-and-support/#pro-support" >}}).
4848

49-
You can use the Pro image to start your LocalStack container using various [installation methods](https://docs.localstack.cloud/getting-started/installation/).
49+
You can use the Pro image to start your LocalStack container using various [installation methods]({{< ref "installation" >}}).
5050
While configuring to run LocalStack with Docker or Docker Compose, run the `localstack/localstack-pro` image with the appropriate tag you have pulled (if not `latest`).
5151

5252
{{< callout >}}

0 commit comments

Comments
 (0)