diff --git a/content/en/user-guide/tools/localstack-extensions/aws-replicator-extension/index.md b/content/en/user-guide/tools/localstack-extensions/aws-replicator-extension/index.md index 4a218a1c8c..60a2701917 100644 --- a/content/en/user-guide/tools/localstack-extensions/aws-replicator-extension/index.md +++ b/content/en/user-guide/tools/localstack-extensions/aws-replicator-extension/index.md @@ -1,15 +1,14 @@ --- -title: "AWS Replicator Extension" -linkTitle: "AWS Replicator Extension" +title: "AWS Replicator" +linkTitle: "AWS Replicator" weight: 1 -description: > - A LocalStack extension to replicate AWS resources into your local machine +description: A LocalStack extension that replicates AWS resources into your LocalStack container --- -AWS Replicator Extension is a LocalStack extension that allows you to replicate AWS resources into your local machine. +AWS Replicator Extension is a LocalStack extension that allows you to replicate AWS resources into your LocalStack container. {{}} -This Extension is experimental and still under active development. Please report any issues or feature requests on our [GitHub repository](https://github.com/localstack/localstack-extensions). +This Extension is experimental and still under active development. Report any issues or feature requests on our [GitHub repository](https://github.com/localstack/localstack-extensions). {{}} ## Installation diff --git a/content/en/user-guide/tools/localstack-extensions/diagnosis-viewer-extension/diagnosis-viewer-extension.png b/content/en/user-guide/tools/localstack-extensions/diagnosis-viewer-extension/diagnosis-viewer-extension.png new file mode 100644 index 0000000000..309423f6f9 Binary files /dev/null and b/content/en/user-guide/tools/localstack-extensions/diagnosis-viewer-extension/diagnosis-viewer-extension.png differ diff --git a/content/en/user-guide/tools/localstack-extensions/diagnosis-viewer-extension/index.md b/content/en/user-guide/tools/localstack-extensions/diagnosis-viewer-extension/index.md new file mode 100644 index 0000000000..c23f7df919 --- /dev/null +++ b/content/en/user-guide/tools/localstack-extensions/diagnosis-viewer-extension/index.md @@ -0,0 +1,32 @@ +--- +title: "Diagnosis Viewer" +linkTitle: "Diagnostic Viewer" +weight: 6 +description: A LocalStack extension that makes Diagnosis Viewer available in LocalStack! +--- + +This extension makes Diagnosis Viewer to view the diagnostics endpoint available directly in LocalStack. + +## Installation + +To install the Extension, run the following command: + +{{< command >}} +$ localstack extensions install localstack-extension-diagnosis-viewer +{{< / command >}} + +You can also install the Extension using the [Extensions Installer](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-diagnosis-viewer&subdirectory=diagnosis-viewer) which is available in the LocalStack Web Application. + +## Usage + +This Extension serves as a Web User-Interface for the diagnostic endpoint of LocalStack, which becomes active when LocalStack is launched with `DEBUG=1`. + +You can access the diagnostic endpoint through the following command: + +{{< command >}} +$ curl -s localhost:4566/_localstack/diagnose +{{< / command >}} + +Subsequently, you can access the web UI at [**localhost:4566/diapretty**](http://localhost:4566/diapretty). + + \ No newline at end of file diff --git a/content/en/user-guide/tools/localstack-extensions/httpbin-extension/httpbin-localstack-extension-terminal.png b/content/en/user-guide/tools/localstack-extensions/httpbin-extension/httpbin-localstack-extension-terminal.png new file mode 100644 index 0000000000..215c7da0d8 Binary files /dev/null and b/content/en/user-guide/tools/localstack-extensions/httpbin-extension/httpbin-localstack-extension-terminal.png differ diff --git a/content/en/user-guide/tools/localstack-extensions/httpbin-extension/httpbin-localstack-extension-ui.png b/content/en/user-guide/tools/localstack-extensions/httpbin-extension/httpbin-localstack-extension-ui.png new file mode 100644 index 0000000000..3b36a8f5fb Binary files /dev/null and b/content/en/user-guide/tools/localstack-extensions/httpbin-extension/httpbin-localstack-extension-ui.png differ diff --git a/content/en/user-guide/tools/localstack-extensions/httpbin-extension/index.md b/content/en/user-guide/tools/localstack-extensions/httpbin-extension/index.md new file mode 100644 index 0000000000..9f113a4b55 --- /dev/null +++ b/content/en/user-guide/tools/localstack-extensions/httpbin-extension/index.md @@ -0,0 +1,30 @@ +--- +title: "httpbin" +linkTitle: "httpbin" +weight: 5 +description: A LocalStack extension that makes httpbin available in LocalStack! +--- + +This extension makes [httpbin](https://httpbin.org/), a simple HTTP Request & Response Service, available directly in LocalStack. + +## Installation + +To install the Extension, run the following command: + +{{< command >}} +$ localstack extensions install localstack-extension-httpbin +{{< / command >}} + +You can also install the Extension using the [Extensions Installer](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-httpbin&subdirectory=httpbin) which is available in the LocalStack Web Application. + +## Usage + +You can access the Flasgger UI by opening [**httpbin.localhost.localstack.cloud:4566**](http://httpbin.localhost.localstack.cloud:4566/) in your web browser. + + +

+ +You can call the API endpoints just as you would call any other API endpoint with httpbin. + + +

diff --git a/content/en/user-guide/tools/localstack-extensions/mailhog/index.md b/content/en/user-guide/tools/localstack-extensions/mailhog/index.md new file mode 100644 index 0000000000..d2f7758133 --- /dev/null +++ b/content/en/user-guide/tools/localstack-extensions/mailhog/index.md @@ -0,0 +1,43 @@ +--- +title: "MailHog" +linkTitle: "MailHog" +weight: 4 +description: A LocalStack extension that makes MailHog available in LocalStack! +--- + +This extension makes [MailHog](https://github.com/mailhog/MailHog) for Web and API based STMP testing available directly in LocalStack. + +## Installation + +To install the Extension, run the following command: + +{{< command >}} +$ localstack extensions install "git+https://github.com/localstack/localstack-extensions/#egg=localstack-mailhog-extension&subdirectory=mailhog" +{{< / command >}} + +You can also install the Extension using the [Extensions Installer](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-mailhog&subdirectory=mailhog) which is available in the LocalStack Web Application. + +## Usage + +When utilizing this extension, LocalStack is automatically set up to utilize the MailHog SMTP server for sending emails. You can execute the following AWS CLI commands to verify an email address and send an email: + +{{< command >}} +$ awslocal ses verify-email-identity --email-address user1@yourdomain.com +$ awslocal ses send-email \ + --from user1@yourdomain.com \ + --message 'Body={Text={Data="Hello from LocalStack to MailHog"}},Subject={Data=Test Email}' \ + --destination 'ToAddresses=recipient1@example.com' +{{< / command >}} + +You can then access the MailHog UI at [**mailhog.localhost.localstack.cloud:4566**](http://mailhog.localhost.localstack.cloud:4566/) or [**localhost:4566/mailhog**](http://localhost:4566/mailhog/) to view the received email. + + +

+ +## Configuration + +To configure the Extension, you can make use of the [MailHog configuration environment variables](https://github.com/mailhog/MailHog/blob/master/docs/CONFIG.md). When working with the LocalStack CLI, you can include them by employing the following syntax: `DOCKER_FLAGS='-e MH_= -e ...'`. In case you are working within a Docker-Compose setup, simply add these variables as environment settings for the respective container. + +## Limitations + +The MailHog UI offers real-time updates through WebSockets, a feature not currently supported on the default `:4566` port. If you encounter this error in the LocalStack logs when accessing the UI, rest assured that it can be safely ignored. diff --git a/content/en/user-guide/tools/localstack-extensions/mailhog/mailhog-localstack-extension-ui.png b/content/en/user-guide/tools/localstack-extensions/mailhog/mailhog-localstack-extension-ui.png new file mode 100644 index 0000000000..a400b3c609 Binary files /dev/null and b/content/en/user-guide/tools/localstack-extensions/mailhog/mailhog-localstack-extension-ui.png differ diff --git a/content/en/user-guide/tools/localstack-extensions/miniflare-extension/index.md b/content/en/user-guide/tools/localstack-extensions/miniflare-extension/index.md new file mode 100644 index 0000000000..c5f6809d68 --- /dev/null +++ b/content/en/user-guide/tools/localstack-extensions/miniflare-extension/index.md @@ -0,0 +1,49 @@ +--- +title: "Miniflare" +linkTitle: "Miniflare" +weight: 3 +description: A LocalStack extension that makes Miniflare available in LocalStack! +--- + +This extension makes [Miniflare](https://miniflare.dev/), a simulator for developing and testing [Cloudflare Workers](https://workers.cloudflare.com/), available directly in LocalStack. + +{{}} +This Extension is experimental and still under active development. Report any issues or feature requests on our [GitHub repository](https://github.com/localstack/localstack-extensions). +{{}} + +## Installation + +To install the Extension, run the following command: + +{{< command >}} +$ localstack extensions install "git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-miniflare&subdirectory=miniflare" +{{< / command >}} + +You can also install the Extension using the [Extensions Installer](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-miniflare&subdirectory=miniflare) which is available in the LocalStack Web Application. + +## Usage + +To publish the sample application to Miniflare running in LocalStack, we can use the `wrangler` CLI with the following environment variables for local dev mode: + +{{< command >}} +$ export CLOUDFLARE_API_TOKEN=test +$ export CLOUDFLARE_API_BASE_URL=http://localhost:4566/miniflare +$ wrangler publish +{{< / command >}} + +{{}} +If you encounter issues with this configuration, such as receiving `Fetch failed` error messages during `wrangler publish`, consider using this alternative API endpoint: + +{{< command >}} +$ export CLOUDFLARE_API_BASE_URL=https://localhost.localstack.cloud:4566/miniflare +{{< / command >}} +{{}} + +Once deployed, the Cloudflare worker can be easily invoked via `curl`: + +{{< command >}} +$ curl http://hello.miniflare.localhost.localstack.cloud:4566/test + +Hello World! + +{{< / command >}} diff --git a/content/en/user-guide/tools/localstack-extensions/stripe-extension/index.md b/content/en/user-guide/tools/localstack-extensions/stripe-extension/index.md index 4204ddb0e4..494dcebf69 100644 --- a/content/en/user-guide/tools/localstack-extensions/stripe-extension/index.md +++ b/content/en/user-guide/tools/localstack-extensions/stripe-extension/index.md @@ -1,6 +1,6 @@ --- -title: "Stripe Extension" -linkTitle: "Stripe Extension" +title: "Stripe" +linkTitle: "Stripe" weight: 2 description: > A LocalStack extension that provides a mocked version of Stripe as a service