Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add docs for extensions library #842

Merged
merged 2 commits into from
Oct 3, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
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.
36 changes: 36 additions & 0 deletions content/en/user-guide/web-application/extensions-library/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: "Extensions Library"
weight: 5
description: Get started with Extensions Library to extend LocalStack by adding new services and features via Extension mechanism.
HarshCasper marked this conversation as resolved.
Show resolved Hide resolved
---

## Introduction

LocalStack Extensions that allow developers to extend and customize LocalStack. A LocalStack Extension is a Python application that runs together with LocalStack within the LocalStack container.
HarshCasper marked this conversation as resolved.
Show resolved Hide resolved
HarshCasper marked this conversation as resolved.
Show resolved Hide resolved

LocalStack Extensions are available to the licensed users, and the list of available extensions is available in the [Extensions Library](https://app.localstack.cloud/extensions/library).
HarshCasper marked this conversation as resolved.
Show resolved Hide resolved
HarshCasper marked this conversation as resolved.
Show resolved Hide resolved

<img src="extensions-library-ui.png" alt="LocalStack Extensions Library" title="LocalStack Extensions Library" width="900" />

## Installing an Extension

To install an Extension using the LocalStack Extensions Library, you can navigate to the [**app.localstack.cloud/extensions/library**](https://app.localstack.cloud/extensions/library) and click on the **Go to Instance** button to open the list of available instances. If you are running your LocalStack instance locally, you can click on the **Default** option.

You will be redirected to the LocalStack Instance page, where you can directly click the **Install** button to install the Extension. The installation process will take a few seconds, and will restart your LocalStack instance. Click **Continue** to proceed.
HarshCasper marked this conversation as resolved.
Show resolved Hide resolved
HarshCasper marked this conversation as resolved.
Show resolved Hide resolved

## Managing Extensions

You can further manage the installed Extensions by navigating to the **Extensions** tab in the LocalStack Instance page. You can remove an Extension by clicking the **Remove** button.

<img src="extensions-library-management.png" alt="Installed LocalStack Extensions Library" title="Installed LocalStack Extensions Library" width="900" />

### Supported Extensions

The following Extensions are currently available in the Extensions Library:

- [AWS Replicator](https://docs.localstack.cloud/user-guide/tools/localstack-extensions/aws-replicator-extension/)
HarshCasper marked this conversation as resolved.
Show resolved Hide resolved
- [Stripe](https://docs.localstack.cloud/user-guide/tools/localstack-extensions/stripe-extension/)
- [Miniflare](https://docs.localstack.cloud/user-guide/tools/localstack-extensions/miniflare-extension/)
- [MailHog](https://docs.localstack.cloud/user-guide/tools/localstack-extensions/mailhog/)
- [httpbin](https://docs.localstack.cloud/user-guide/tools/localstack-extensions/httpbin-extension/)
- [Diagnostic Viewer](https://docs.localstack.cloud/user-guide/tools/localstack-extensions/diagnosis-viewer-extension/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe round it out with a
## Create your own extension
section that gives basic instructions or provides further links.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will do once this PR is merged #750