Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: 5 days 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 (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T20:46:36.000Z (15 days ago)
- Last Synced: 2024-10-29T22:51:45.742Z (15 days ago)
- Topics: administration, alpine, aws, aws-sqs, docker, hacktoberfest, localstack, sqs, sqs-insight, webui
- Language: TypeScript
- Homepage:
- Size: 4.97 MB
- Stars: 51
- Watchers: 2
- Forks: 6
- Open Issues: 9
-
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
README
# SQS-Admin
A minimal and lightweight UI for managing SQS-Queues for local development e.g. with [Localstack](https://localstack.cloud/).
## 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 Alpine based image has a size ~19 MB. You can easily manage and create Queues.
## Usage
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`
## 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))
**Localstack >= 3.5.0** is currently not supported, due to breaking changes.
## 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).
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`.
## Designed and tested with
## 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
💻
### Legal note
UI favicon by [John Sorrentino](https://favicon.io/emoji-favicons/cowboy-hat-face)