Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,13 @@ Commands:
```

To install an extension, specify the name of the pip dependency that contains
the extension. For example, for the official Stripe extension, you can either
use the package distributed on pypi:
the extension. For example, for the official httpbin extension, use the package
distributed on PyPI:

```console
$ localstack extensions install localstack-extension-httpbin
```

or you can install the latest version directly from this Git repository

```console
$ localstack extensions install "git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-httpbin&subdirectory=httpbin"
```

## Official LocalStack Extensions

Here is the current list of extensions developed by the LocalStack team and their support status.
Expand Down
2 changes: 0 additions & 2 deletions diagnosis-viewer/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
Diagnosis Viewer
===============================
[![Install LocalStack Extension](https://localstack.cloud/gh/extension-badge.svg)](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-diagnosis-viewer&subdirectory=diagnosis-viewer)

View the diagnostics endpoint directly in localstack

## Access Diagnosis Data
Expand Down
2 changes: 0 additions & 2 deletions hello-world/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
Hello World LocalStack extension
================================
[![Install LocalStack Extension](https://localstack.cloud/gh/extension-badge.svg)](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-hello-world&subdirectory=hello-world)

A minimal LocalStack extension.

## What does it do?
Expand Down
2 changes: 0 additions & 2 deletions httpbin/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
LocalStack httpbin extension
===============================
[![Install LocalStack Extension](https://localstack.cloud/gh/extension-badge.svg)](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-httpbin&subdirectory=httpbin)

A simple HTTP Request & Response Service directly in LocalStack
using [httpbin](https://github.com/postmanlabs/httpbin).
Get the full httpbin experience directly in LocalStack without connecting to httpbin.org!
Expand Down
2 changes: 1 addition & 1 deletion keycloak/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This Extension:
## Installation

```bash
localstack extensions install "git+https://github.com/localstack/localstack-extensions.git#egg=localstack-keycloak&subdirectory=keycloak"
localstack extensions install localstack-keycloak
```

## Install local development version
Expand Down
10 changes: 0 additions & 10 deletions mailhog/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
LocalStack Mailhog Extension
===============================
[![Install LocalStack Extension](https://localstack.cloud/gh/extension-badge.svg)](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-mailhog&subdirectory=mailhog)

Web and API based SMTP testing directly in LocalStack using [MailHog](https://github.com/mailhog/MailHog).

If the standard configuration is used, LocalStack will serve the UI through http://mailhog.localhost.localstack.cloud:4566 or http://localhost:4566/mailhog/.
Expand All @@ -22,14 +20,6 @@ After starting LocalStack, you should see these lines in the log:
2023-07-26T10:00:08.072 INFO --- [ MainThread] mailhog.extension : serving mailhog extension on path: http://localhost:4566/mailhog/
```

## Install from GitHub repository

Alternatively, you can install the latest unreleased version directly from the GitHub repository by running:

```bash
localstack extensions install "git+https://github.com/localstack/localstack-extensions/#egg=localstack-mailhog-extension&subdirectory=mailhog"
```

## Integration with LocalStack

When using this extension, LocalStack is automatically configured to use the MailHog SMTP server when sending emails.
Expand Down
4 changes: 1 addition & 3 deletions miniflare/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
Miniflare LocalStack extension (experimental)
=============================================
[![Install LocalStack Extension](https://localstack.cloud/gh/extension-badge.svg)](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-miniflare&subdirectory=miniflare)

This extension makes [Miniflare](https://miniflare.dev) (dev environment for Cloudflare workers) available directly in LocalStack!

⚠️ Please note that this extension is experimental and currently under active development.

## Installing

```bash
localstack extensions install "git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-miniflare&subdirectory=miniflare"
localstack extensions install localstack-extension-miniflare
```

## How to use
Expand Down
6 changes: 3 additions & 3 deletions mockoon/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ The extension runs the [Mockoon CLI](https://mockoon.com/cli/) (`mockoon/cli:9`
- `make` and Terraform (for the sample app)
- [Mockoon desktop app](https://mockoon.com/download/) (optional, for designing your mock APIs)

## Install from GitHub repository
## Install from PyPI

`lstk` does not have commands for managing extensions, but LocalStack can install the extension at startup via the `EXTENSION_AUTO_INSTALL` config variable:

```bash
LOCALSTACK_EXTENSION_AUTO_INSTALL="git+https://github.com/localstack/localstack-extensions.git#egg=localstack-mockoon&subdirectory=mockoon" lstk start
LOCALSTACK_EXTENSION_AUTO_INSTALL="localstack-mockoon" lstk start
```

Alternatively, if you are using the legacy `localstack` CLI:

```bash
localstack extensions install "git+https://github.com/localstack/localstack-extensions.git#egg=localstack-mockoon&subdirectory=mockoon"
localstack extensions install localstack-mockoon
```

## Install local development version
Expand Down
6 changes: 2 additions & 4 deletions paradedb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,10 @@ The following environment variables can be passed to the LocalStack container to
* `localstack` CLI
* `make`

## Install from GitHub repository

This extension can be installed directly from this Github repo via:
## Install from PyPI

```bash
localstack extensions install "git+https://github.com/localstack/localstack-extensions.git#egg=localstack-extension-paradedb&subdirectory=paradedb"
localstack extensions install localstack-extension-paradedb
```

## Install local development version
Expand Down
2 changes: 0 additions & 2 deletions prometheus/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# LocalStack Prometheus Metrics
[![Install LocalStack Extension](https://localstack.cloud/gh/extension-badge.svg)](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-prometheus-metrics&subdirectory=prometheus)

Instruments, collects, and exposes LocalStack metrics via a [Prometheus](https://prometheus.io/) endpoint.

## Installing
Expand Down
2 changes: 0 additions & 2 deletions stripe/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
Stripe LocalStack extensions
============================
[![Install LocalStack Extension](https://localstack.cloud/gh/extension-badge.svg)](https://app.localstack.cloud/extensions/remote?url=git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-stripe&subdirectory=stripe)

A LocalStack extension that provides a mocked version of [Stripe](https://stripe.com) as a service.

## Installing
Expand Down
6 changes: 3 additions & 3 deletions template/{{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ You can then start LocalStack with `EXTENSION_DEV_MODE=1` to load all enabled ex
EXTENSION_DEV_MODE=1 localstack start
```

## Install from GitHub repository
## Publish to PyPI

To distribute your extension, simply upload it to your github account. Your extension can then be installed via:
To distribute your extension, publish it to PyPI with `make publish`. It can then be installed via:

```bash
localstack extensions install "git+https://github.com/{{cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/#egg={{ cookiecutter.project_slug }}"
localstack extensions install {{ cookiecutter.project_slug }}
```
6 changes: 3 additions & 3 deletions templates/basic/{{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ You can then start LocalStack with `EXTENSION_DEV_MODE=1` to load all enabled ex
EXTENSION_DEV_MODE=1 localstack start
```

## Install from GitHub repository
## Publish to PyPI

To distribute your extension, simply upload it to your github account. Your extension can then be installed via:
To distribute your extension, publish it to PyPI with `make publish`. It can then be installed via:

```bash
localstack extensions install "git+https://github.com/{{cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/#egg={{ cookiecutter.project_slug }}"
localstack extensions install {{ cookiecutter.project_slug }}
```
6 changes: 3 additions & 3 deletions templates/react/{{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ There are a few make commands available that will help your journey with the UI:
- **start-frontend**: will start a live server on port 3000 (by default) that will allow you to have hot reloading when developing locally outside the extension (it will also build the frontend)


## Install from GitHub repository
## Publish to PyPI

To distribute your extension, simply upload it to your github account. Your extension can then be installed via:
To distribute your extension, publish it to PyPI with `make publish`. It can then be installed via:

```bash
localstack extensions install "git+https://github.com/{{cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/#egg={{ cookiecutter.project_slug }}"
localstack extensions install {{ cookiecutter.project_slug }}
```
6 changes: 2 additions & 4 deletions terraform-init/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,8 @@ You can then start LocalStack with `EXTENSION_DEV_MODE=1` to load all enabled ex
EXTENSION_DEV_MODE=1 localstack start
```

## Install from GitHub repository

To distribute your extension, simply upload it to your github account. Your extension can then be installed via:
## Install from PyPI

```bash
localstack extensions install "git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-terraform-init&subdirectory=terraform-init"
localstack extensions install localstack-extension-terraform-init
```
6 changes: 2 additions & 4 deletions typedb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,10 @@ The following environment variables can be passed to the LocalStack container (m
* `localstack` CLI
* `make`

## Install from GitHub repository

This extension can be installed directly from this Github repo via:
## Install from PyPI

```bash
localstack extensions install "git+https://github.com/localstack/localstack-extensions.git#egg=typedb&subdirectory=typedb"
localstack extensions install localstack-extension-typedb
```

## Install local development version
Expand Down
9 changes: 0 additions & 9 deletions utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,6 @@ dependencies = [
]
```

Or, to install directly from the GitHub repository:
Comment thread
alexrashed marked this conversation as resolved.

```toml
[project]
dependencies = [
"localstack-extensions-utils @ git+https://github.com/localstack/localstack-extensions.git#subdirectory=utils",
]
```

Then import the utilities in your extension code, for example:

```python
Expand Down
6 changes: 2 additions & 4 deletions wiremock/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,10 @@ The extension supports two modes:
- `make`
- [WireMock CLI](https://docs.wiremock.io/cli/overview) (for WireMock Runner mode)

## Install from GitHub repository

This extension can be installed directly from this Github repo via:
## Install from PyPI

```bash
localstack extensions install "git+https://github.com/localstack/localstack-extensions.git#egg=localstack-wiremock&subdirectory=wiremock"
localstack extensions install localstack-wiremock
```

## Install local development version
Expand Down
Loading