From e71a5f2bb54682c691e3925521fcb7264e9f12ee Mon Sep 17 00:00:00 2001 From: Kiah Imani Date: Mon, 13 Jul 2026 07:51:01 -0400 Subject: [PATCH] remove deprecated LocalSurf page Remove the LocalSurf browser extension docs from the Networking section. The extension is experimental, unmaintained, and its use case is now covered by Transparent Endpoint Injection and the DNS Server docs. - Delete src/content/docs/aws/customization/networking/localsurf.md - Redirect /aws/customization/networking/localsurf to the Networking overview - Remove internal references to LocalSurf --- astro.config.mjs | 4 -- public/_redirects | 12 ++-- scripts/redirects/_redirects | 2 +- scripts/redirects/redirects_config.json | 2 +- src/content/docs/aws/configuration/index.mdx | 2 +- .../docs/aws/configuration/localsurf.md | 72 ------------------- 6 files changed, 9 insertions(+), 85 deletions(-) delete mode 100644 src/content/docs/aws/configuration/localsurf.md diff --git a/astro.config.mjs b/astro.config.mjs index 806385428..1b91f906b 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -629,10 +629,6 @@ export default defineConfig({ label: 'LocalStack Docker Extension', slug: 'aws/configuration/localstack-docker-extension', }, - { - label: 'LocalSurf', - slug: 'aws/configuration/localsurf', - }, ], }, { diff --git a/public/_redirects b/public/_redirects index 2fcbfbf92..f626cd01c 100644 --- a/public/_redirects +++ b/public/_redirects @@ -122,7 +122,7 @@ /references/coverage/coverage_es/ /aws/services/es 301 /user-guide/integrations/sdks/javascript/ /aws/connecting/aws-sdks/net/javascript 301 /references/coverage/coverage_iam/ /aws/services/iam 301 -/user-guide/tools/localsurf/ /aws/configuration/localsurf 301 +/user-guide/tools/localsurf/ /aws/customization/networking/ 301 /user-guide/extensions/extensions-library/ /aws/configuration/extensions/extensions-library 301 /tutorials/ecs-ecr-container-app/ /aws/tutorials/ecs-ecr-container-app 301 /references/coverage/coverage_elastictranscoder/ /aws/services/elastictranscoder 301 @@ -529,7 +529,7 @@ /references/coverage/coverage_es /aws/services/es 301 /user-guide/integrations/sdks/javascript /aws/connecting/aws-sdks/net/javascript 301 /references/coverage/coverage_iam /aws/services/iam 301 -/user-guide/tools/localsurf /aws/configuration/localsurf 301 +/user-guide/tools/localsurf /aws/customization/networking/ 301 /user-guide/extensions/extensions-library /aws/configuration/extensions/extensions-library 301 /tutorials/ecs-ecr-container-app /aws/tutorials/ecs-ecr-container-app 301 /references/coverage/coverage_elastictranscoder /aws/services/elastictranscoder 301 @@ -944,8 +944,8 @@ /aws/tooling/testing-utils/ /aws/configuration/testing-utils 301 /aws/tooling/localstack-docker-extension /aws/configuration/localstack-docker-extension 301 /aws/tooling/localstack-docker-extension/ /aws/configuration/localstack-docker-extension 301 -/aws/tooling/localsurf /aws/configuration/localsurf 301 -/aws/tooling/localsurf/ /aws/configuration/localsurf 301 +/aws/tooling/localsurf /aws/customization/networking/ 301 +/aws/tooling/localsurf/ /aws/customization/networking/ 301 /aws/tooling /aws/developer-tools 301 /aws/tooling/ /aws/developer-tools/ 301 @@ -999,8 +999,8 @@ /aws/capabilities/localstack-sdks/java-sdk/ /aws/configuration/localstack-sdks/java-sdk 301 /aws/capabilities/localstack-sdks/python-sdk /aws/configuration/localstack-sdks/python-sdk 301 /aws/capabilities/localstack-sdks/python-sdk/ /aws/configuration/localstack-sdks/python-sdk 301 -/aws/capabilities/localsurf /aws/configuration/localsurf 301 -/aws/capabilities/localsurf/ /aws/configuration/localsurf 301 +/aws/capabilities/localsurf /aws/customization/networking/ 301 +/aws/capabilities/localsurf/ /aws/customization/networking/ 301 /aws/capabilities/networking /aws/configuration/networking 301 /aws/capabilities/networking/ /aws/configuration/networking 301 /aws/capabilities/networking/accessing-endpoint-url /aws/configuration/networking/accessing-endpoint-url 301 diff --git a/scripts/redirects/_redirects b/scripts/redirects/_redirects index da10a1531..213b5ab6c 100644 --- a/scripts/redirects/_redirects +++ b/scripts/redirects/_redirects @@ -121,7 +121,7 @@ /references/coverage/coverage_es/ /aws/services/es 301 /user-guide/integrations/sdks/javascript/ /aws/integrations/aws-sdks/net/javascript 301 /references/coverage/coverage_iam/ /aws/services/iam 301 -/user-guide/tools/localsurf/ /aws/tooling/localsurf 301 +/user-guide/tools/localsurf/ /aws/customization/networking/ 301 /user-guide/extensions/extensions-library/ /aws/tooling/extensions/extensions-library 301 /tutorials/ecs-ecr-container-app/ /aws/tutorials/ecs-ecr-container-app 301 /references/coverage/coverage_elastictranscoder/ /aws/services/elastictranscoder 301 diff --git a/scripts/redirects/redirects_config.json b/scripts/redirects/redirects_config.json index 6f3580563..50ccf6902 100644 --- a/scripts/redirects/redirects_config.json +++ b/scripts/redirects/redirects_config.json @@ -612,7 +612,7 @@ }, { "old_link": "/user-guide/tools/localsurf/", - "new_link": "/aws/tooling/localsurf", + "new_link": "/aws/customization/networking", "status_code": 301 }, { diff --git a/src/content/docs/aws/configuration/index.mdx b/src/content/docs/aws/configuration/index.mdx index ed3684e56..fb77458eb 100644 --- a/src/content/docs/aws/configuration/index.mdx +++ b/src/content/docs/aws/configuration/index.mdx @@ -13,7 +13,7 @@ LocalStack provides a number of configuration options and supporting tools that It brings together the configuration options that control LocalStack's behavior, networking setup for reaching your services, the LocalStack Web App, the LocalStack SDKs for programmatic access, and the extensions mechanism for adding new functionality. -You will also find guides for several standalone tools: the [DNS Server](/aws/configuration/dns-server), [Testing Utils](/aws/configuration/testing-utils), the [LocalStack Docker Extension](/aws/configuration/localstack-docker-extension), and [LocalSurf](/aws/configuration/localsurf). +You will also find guides for several standalone tools: the [DNS Server](/aws/configuration/dns-server), [Testing Utils](/aws/configuration/testing-utils), and the [LocalStack Docker Extension](/aws/configuration/localstack-docker-extension). This plugin is experimental and still under active development. -> Please report any issues or feature requests on our [GitHub repository](https://github.com/localstack/local-surf). - -## Installation - -This extension is not yet available in the Chrome Web Store, but can be installed directly from source. -Clone the repository on your local machine to get started: - -```bash -git clone git@github.com:localstack/local-surf.git -``` - -Head over to `chrome://extensions/` in Chrome, then select `"Load unpacked"` and point to the directory where the source code files are stored on the disk. - -Once installed, a new icon should appear in the Chrome extensions bar. -When clicking on the icon, the plugin can be enabled/disabled by toggling the **Enable local mode** checkbox. - - -![LocalSurf Extension](/images/aws/localsurf-extension.png) - -## Usage - -To illustrate how the plugin works, we use the AWS [Serverlesspresso](https://github.com/aws-samples/serverless-coffee-workshop) sample application. -This app consists of various backend components (e.g., DynamoDB tables, Lambda functions, Cognito user pools, etc), as well as a hosted Web app user interface (UI) that can be used to interact with the backend components. - -We can deploy the backend components to LocalStack directly, using the `samlocal` command line interface (CLI): - -```bash -samlocal build -samlocal deploy -``` - -Once deployed, the `samlocal` CLI will print out a display app URL which will look similar to the following: - -```bash -Key DisplayAppURI -Description The URL for the Display App -Value https://workshop-display.serverlesscoffee.com/?region=us-east-1&userPoolId=us-east-1_43c9800e64c84467aa0abdb102e226ef&userPoolWebClientId=vr9aw2jr7iv36ezwaaqlzzkvbp&poolId=us-east-1:95dc88d0-1029-48fe-ba7b-1e6a9741bfc5&host=localhost.localstack.cloud&orderManagerEndpoint=https://fapencq0ue.execute-api.amazonaws.com:4566/Prod&APIGWEndpointValidatorService=https://psmdc7b1lv.execute-api.amazonaws.com:4566/Prod&APIGWEndpointConfigService=https://hw7yw61ba7.execute-api.amazonaws.com:4566/Prod -``` - -We can then open the URL in the browser and confirm the configurations in the form dialog: - -![Confirm configurations dialog](/images/aws/serverlesspresso-config.png) - -Once confirmed, we are being forwarded to a signin screen, which uses an AWS Cognito user pool to manage authentication: - -![AWS Cognito sign in](/images/aws/serverlesspresso-login.png) - -After clicking **Sign In** in this form, we can see that the browser makes a request to LocalStack (to `localhost.localstack.cloud`, which is a domain name that resolves to `127.0.0.1`). - -![Chrome Networking](/images/aws/chrome-networking.png) - -This sample demonstrates how we can take an existing Web application, without any modification, and make it talk to the LocalStack APIs directly from the browser via the LocalSurf plugin. - -## Note - -Use this extension at your own risk - it is provided on an as-is basis, **without** warranties or conditions of **any** kind. -In particular, it is your obligation to ensure that the use of this extension is compliant with the user license agreement and the terms & conditions of Amazon Web Services (AWS) and their services. \ No newline at end of file