Update README.md

This commit is contained in:
Simon Fortier 2019-04-06 21:10:07 -04:00 committed by simon987
parent dfeddce2e9
commit fcefad21ca

View File

@ -3,8 +3,34 @@
[![CodeFactor](https://www.codefactor.io/repository/github/simon987/task_tracker/badge)](https://www.codefactor.io/repository/github/simon987/task_tracker)
[![Build Status](https://ci.simon987.net/buildStatus/icon?job=task_tracker)](https://ci.simon987.net/job/task_tracker/)
Fast task tracker with authentication, statistics and web frontend
Fast task tracker (job queue) with authentication, statistics and web frontend
### Features
* Stateless/Fault tolerent
* Integrate projects (or queue, tube) with Github/Gogs/Gitea - make workers aware of new commits
* Granular user permissions for administration tasks
* Prioritisable (project-level and task-level)
* Optionnal unique task constraint
* Per-project rate-limitting
* Per-project and per-worker stats monitoring
![image](https://user-images.githubusercontent.com/7120851/55676940-714cf980-58ac-11e9-8f5d-0d76a7afa80d.png)
### Terminology
**task_tracker** | Beanstalkd | Amazon SQS | IronMQ
:---|:---|:---|:---
Project | Tube | Queue | Queue
Task | Job | Message | Message
Recipe | Job data | Message body | Message body
Submit | Put | Send message | POST
Assign | Reserve | Receive message | GET
Release | Delete | Delete message | DELETE
max_assign_time | TTR (time-to-run) | Visibility timeout | Timeout
\- | Delay | Delivery delay | Delay
\- | - | Retention Period | Expires in
### Postgres setup
@ -13,7 +39,7 @@ sudo su postgres
createuser task_tracker
createdb task_tracker
psql task_tracker
> 
> ALTER USER "task_tracker" WITH PASSWORD 'task_tracker';
```
### Nginx Setup