mirror of
https://github.com/hibiken/asynqmon.git
synced 2025-09-22 06:46:34 +08:00
Add README and LICENSE files
This commit is contained in:
43
README.md
Normal file
43
README.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# Asynqmon
|
||||
|
||||
Asynqmon is a web based tool for monitoring and administrating Asynq queues and tasks.
|
||||
|
||||
## Installation
|
||||
|
||||
### Release binaries
|
||||
|
||||
You can download the release binary for your system from the
|
||||
[releases page](https://github.com/hibiken/asynqmon/releases).
|
||||
|
||||
### Building from source
|
||||
|
||||
To build Asynqmon from source code, first ensure that have a working
|
||||
Go environment with [version 1.16 or greater installed](https://golang.org/doc/install).
|
||||
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 and then run:
|
||||
|
||||
```sh
|
||||
$ make build
|
||||
```
|
||||
|
||||
The `asynqmon` binary should be created in the current directory.
|
||||
|
||||
## Usage
|
||||
|
||||
To start the server, run
|
||||
|
||||
```sh
|
||||
$ asynqmon
|
||||
```
|
||||
|
||||
Pass flags to specify port, redis server address, etc.
|
||||
|
||||
```sh
|
||||
$ asynqmon --port=3000 --redis_addr=localhost:6380
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Asynqmon is released under the MIT license. See [LICENSE](https://github.com/hibiken/asynqmon/blob/master/LICENSE).
|
Reference in New Issue
Block a user