Asynqmon logo # A modern web based tool for monitoring & administrating [Asynq](https://github.com/hibiken/asynq) queues, tasks and message broker > ☝️ **Important Note**: Current version of Asynqmon is compatible with Asynq [`v0.15.x`](https://github.com/hibiken/asynq/releases) or above. ## Install ### Release binaries You can download the release binary for your system from the [releases page](https://github.com/hibiken/asynqmon/releases). ### Docker image To pull the Docker image: ```bash # Pull the latest image docker pull hibiken/asynqmon # Or specify the image by tag docker pull hibiken/asynqmon[:tag] ``` ### Building from source To build Asynqmon from source code, make sure you have Go installed ([download](https://golang.org/dl/)). Version `1.16` or higher is required. You also need [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/) installed in order to build the frontend assets. Download the source code of this repository and then run: ```bash make build ``` The `asynqmon` binary should be created in the current directory. ### Building Docker image locally To build Docker image locally, run: ```bash make docker ``` ## Run To use the defaults, simply run and open http://localhost:8080. ```bash # with a local binary ./asynqmon # with docker docker run --rm \ --name asynqmon \ -p 8080:8080 \ hibiken/asynqmon ``` By default, Asynqmon web server listens on port `8080` and connects to a Redis server listening on `127.0.0.1:6379`. Pass flags to specify port, redis server address, etc. ```bash # with a local binary ./asynqmon --port=3000 --redis-addr=localhost:6380 # with Docker (connect to a Redis server running on the host machine) docker run --rm \ --name asynqmon \ -p 3000:3000 \ hibiken/asynqmon --port=3000 --redis-addr=host.docker.internal:6380 # with Docker (connect to a Redis server running in the Docker container) docker run --rm \ --name asynqmon \ --network dev-network \ -p 8080:8080 \ hibiken/asynqmon --redis-addr=dev-redis:6379 ``` To see all available flags, run: ```bash # with a local binary ./asynqmon --help # with Docker docker run hibiken/asynqmon --help ``` Next, go to [localhost:8080](http://localhost:8080) and see Asynqmon dashboard: ![Web UI Queues View](https://user-images.githubusercontent.com/11155743/114697016-07327f00-9d26-11eb-808c-0ac841dc888e.png) **Tasks view** ![Web UI TasksView](https://user-images.githubusercontent.com/11155743/114697070-1f0a0300-9d26-11eb-855c-d3ec263865b7.png) **Settings and adaptive dark mode** ![Web UI Settings and adaptive dark mode](https://user-images.githubusercontent.com/11155743/114697149-3517c380-9d26-11eb-9f7a-ae2dd00aad5b.png) ## License Copyright (c) 2019-present [Ken Hibino](https://github.com/hibiken) and [Contributors](https://github.com/hibiken/asynqmon/graphs/contributors). `Asynqmon` is free and open-source software licensed under the [MIT License](https://github.com/hibiken/asynq/blob/master/LICENSE). Official logo was created by [Vic Shóstak](https://github.com/koddr) and distributed under [Creative Commons](https://creativecommons.org/publicdomain/zero/1.0/) license (CC0 1.0 Universal).