https://github.com/PacoVK/sqs-admin

A simple UI for local SQS
https://github.com/PacoVK/sqs-admin

administration alpine aws aws-sqs docker hacktoberfest localstack sqs sqs-insight webui

Last synced: 3 months ago
JSON representation

A simple UI for local SQS

Host: GitHub
URL: https://github.com/PacoVK/sqs-admin
Owner: PacoVK
License: apache-2.0
Created: 2022-05-17T13:56:11.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2025-04-09T19:11:34.000Z (3 months ago)
Last Synced: 2025-04-09T20:23:54.114Z (3 months ago)
Topics: administration, alpine, aws, aws-sqs, docker, hacktoberfest, localstack, sqs, sqs-insight, webui
Language: TypeScript
Homepage: https://pascal.euhus.dev/sqs-admin/
Size: 5.99 MB
Stars: 65
Watchers: 2
Forks: 9
Open Issues: 8
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-localstack - SQS Admin
awesome-localstack - SQS Admin

README

A minimal and lightweight UI for managing SQS-Queues for local development e.g. with [Localstack](https://localstack.cloud/).

![Sqs-Admin](screenshot.png)

## Why

There are already good UIs for SQS, but they are heavy with sizes >100 MB. Most likely because they ship with SQS itself.
If you choose e.g. Localstack for local development you don't need an additional local SQS setup, as it is already
provided by Localstack, unfortunately without UI.
**This image has a size ~8 MB**. You can easily manage and create Queues.

## Usage

### Standalone Mode

The most common way to use SQS-Admin would be in conjunction with a `docker-compose.yml`.
A working example can be found in the `example` directory.

You probably need to have a SQS up and running somewhere to connect to, e.g. via Localstack.
To start SQS-Admin simply run:
`docker run --rm -p 3999:3999 -e SQS_ENDPOINT_URL= -d pacovk/sqs-admin`

### LocalStack Extension

SQS-Admin can also be used as a LocalStack extension, which provides a more integrated experience.

More details [here](./localstack/README.md).

## Compatibility

SQS-Admin >= 0.5.4 does not support Localstack < 2.x.
If you need to stick to Localstack 1.x, please use SQS-Admin <= 0.5.3 ([see #928](https://github.com/PacoVK/sqs-admin/issues/928))

## Configuration

You can easily configure the Docker Container via the following environment variables:

| ENV | Description | Default |
| ---------------- | -------------------------------------------------------------- | --------------------- |
| SQS_ENDPOINT_URL | **Endpoint where SQS is running, this one is mostly required** | http://localhost:4566 |
| SQS_AWS_REGION | AWS region the client internally uses to interact with SQS | eu-central-1 |

## Contributing

If you want to contribute to this project, please read the [contribution guidelines](./CONTRIBUTING.md).

## Development

### Run local environment

To start your local development environment you can run `make dev`. This will start a local backend (default http://localhost:3999) and the UI (default http://localhost:3000).

The frontend is built with Vite for a faster and more efficient development experience.

To configure the backend for local development you can set the following environment variable:

| ENV | Description | Default |
| --------- | ------------------------------------------------------ | ------- |
| HTTP_PORT | Port that the internal backend binds to and is serving | 3999 |

### Run tests

To run the tests you can run `make test`. You'll need to shut down your local development environment afterward.

### Shutdown local environment

To shutdown your local development environment you can run `make down`.

### Release

To release a new version:
* Update `vite.config.ts`
* Update `package.json`
* Update `./localstack/pyproject.toml`
* Create a new release on GitHub

## Designed and tested with

![Localstack](https://raw.githubusercontent.com/localstack/.github/main/assets/localstack-readme-banner.svg)

## Contributors ✨

Thanks go to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_PacoVK
💻 👀 📆 🚧 💡

_{Érico Knapp Lutzer}
💻

_{Stanislav Zhuk}
💻

_{Alejandro Perez}
💻

_{Ádám Bordás}
🐛

_{Bhavishya Chandra Kamineni}
💻

_{Daniel Neto}
💻