v0.1-beta1

This commit is contained in:
Ken Hibino 2021-01-31 21:50:46 -08:00
parent 0084648d1c
commit 9f67d9b618
2 changed files with 26 additions and 1 deletions

12
CHANGELOG.md Normal file
View File

@ -0,0 +1,12 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on ["Keep a Changelog"](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [0.1.0-beta1] - 2021-01-31
Initial Beta Release 🎉

View File

@ -2,6 +2,10 @@
Asynqmon is a web based tool for monitoring and administrating Asynq queues and tasks. Asynqmon is a web based tool for monitoring and administrating Asynq queues and tasks.
## Compatibility
Current version of Asynqmon is compatible with [Asynq v0.15 or above](https://github.com/hibiken/asynq/releases).
## Installation ## Installation
### Release binaries ### Release binaries
@ -26,7 +30,10 @@ The `asynqmon` binary should be created in the current directory.
## Usage ## Usage
To start the server, run Asynqmon server needs to connect to redis server to serve data.
By default, it connects to redis server running on port 6379 locally, and the server listens on port 8080.
To use the defaults, simply run and open http://localhost:8080.
```sh ```sh
$ asynqmon $ asynqmon
@ -38,6 +45,12 @@ Pass flags to specify port, redis server address, etc.
$ asynqmon --port=3000 --redis_addr=localhost:6380 $ asynqmon --port=3000 --redis_addr=localhost:6380
``` ```
To see all available flags, run
```sh
$ asynqmon --help
```
## License ## License
Asynqmon is released under the MIT license. See [LICENSE](https://github.com/hibiken/asynqmon/blob/master/LICENSE). Asynqmon is released under the MIT license. See [LICENSE](https://github.com/hibiken/asynqmon/blob/master/LICENSE).