roribio16/alpine-sqs

Alpine SQS (alpine-sqs)

!https://raw.githubusercontent.com/roribio/alpine-sqs/master/banner.png

基于Alpine Linux的Docker化ElasticMQ服务器 + 集成Web UI，用于本地开发。

Alpine SQS提供Amazon Simple Queue Service（AWS-SQS）的容器化Java实现，基于ElasticMQ运行在Alpine Linux和Oracle Java 8 Server-JRE上，兼容AWS API、CLI及Amazon Java SDK，支持快速本地开发，无需承担基础设施成本。

本仓库旨在维护ElasticMQ的更新Docker环境，集成Web UI以可视化队列和消息。

目录

• 背景
• 安装
• 使用
• 维护者
• 贡献
• 许可证

背景

在寻找SQS本地实现时，发现@vsouza的docker-SQS-local镜像（当时超过11K次拉取），由此接触到ElasticMQ（Scala实现的消息队列系统，提供SQS兼容的REST接口）。基于该工作，本项目优化如下：

• 尽可能减小镜像体积
• 自动更新至最新ElasticMQ服务器
• 集成消息队列可视化Web UI
• 自动测试与构建（进行中）
• 详细文档

参考项目

• https://github.com/adamw/elasticmq by @adamw
• https://github.com/kobim/sqs-insight%EF%BC%88fork%E8%87%AAfinanzcheck%E7%9A%84%E5%BD%92%E6%A1%A3%E9%A1%B9%E7%9B%AE%EF%BC%89
• https://github.com/anapsix/docker-alpine-java by anapsix

安装

前提条件

需安装最新版Docker，若自行构建环境，建议安装最新版Docker Compose。

安装方式

1. 从Docker Hub拉取

docker pull roribio16/alpine-sqs

2. 从源码构建

git clone https://github.com/roribio/alpine-sqs.git

使用

运行环境

1. docker run方式

docker run --name alpine-sqs -p 9324:9324 -p 9325:9325 -d roribio16/alpine-sqs:latest

自定义配置：将主机目录（如/opt/alpine-sqs）挂载到容器/opt/custom目录（需包含elasticmq.conf和sqs-insight.conf）：

docker run --name alpine-sqs -p 9324:9324 -p 9325:9325 -v /opt/alpine-sqs:/opt/custom -d roribio16/alpine-sqs:latest

未提供的配置文件将使用默认值（见https://github.com/roribio/alpine-sqs/tree/master/opt%EF%BC%89%E3%80%82

2. docker-compose up方式

克隆仓库后，使用默认docker-compose.yml拉取并运行：

docker-compose up -d

3. docker-compose up --build方式

从源码构建并运行：

docker-compose -f docker-compose.build up -d --build

队列操作

默认队列

默认配置提供default队列，可直接推送消息：http://localhost:9324/queue/default。

死信队列

默认死信队列为dlq（配置见https://github.com/softwaremill/elasticmq#automatically-creating-queues-on-startup%EF%BC%89%E3%80%82

发送消息（AWS CLI示例）

aws --endpoint-url http://localhost:9324 sqs send-message --queue-url http://localhost:9324/queue/default --message-body "Hello, queue!"

查看消息

• Web UI：访问http://localhost:9325（sqs-insight）
• 命令行：

aws --endpoint-url http://localhost:9324 sqs receive-message --queue-url http://localhost:9324/queue/default --wait-time-seconds 10

创建新队列

AWS CLI

aws --endpoint-url http://localhost:9324 sqs create-queue --queue-name newqueue

修改ElasticMQ配置

编辑elasticmq.conf的queues块，添加新队列：

queues {
    default {
        defaultVisibilityTimeout = 10 seconds
        delay = 5 seconds
        receiveMessageWait = 0 seconds
    },
    newqueue {
        defaultVisibilityTimeout = 10 seconds
        delay = 5 seconds
        receiveMessageWait = 0 seconds
    }
}

修改后重启ElasticMQ：

docker exec -it alpine-sqs sh -c "supervisorctl restart elasticmq"

注册队列到UI

编辑sqs-insight.conf的endpoints数组，添加新队列（无需重启UI）：

"endpoints": [
        {
           "key": "notValidKey",
           "secretKey": "notValidSecret",
           "region": "eu-central-1",
           "url": "http://localhost:9324/queue/default"
        },
        {
           "key": "notValidKey",
           "secretKey": "notValidSecret",
           "region": "eu-central-1",
           "url": "http://localhost:9324/queue/newqueue"
        }
    ]

除url外，其他字段为必填但不影响本地使用。

维护者

Ronald E. Oribio R. - https://github.com/roribio

贡献

接受并鼓励PR，如有问题请提交至https://github.com/roribio/alpine-sqs/issues%E3%80%82%E4%BF%AE%E6%94%B9README%E8%AF%B7%E9%81%B5%E5%BE%AAhttps://github.com/RichardLitt/standard-readme%E8%A7%84%E8%8C%83%E3%80%82

许可证

Copyright 2017 Ronald E. Oribio R.
本项目基于GNU General Public License v3.0授权，详见LICENSE。