0
0
Fork 0
mirror of https://github.com/crazy-max/diun.git synced 2025-03-17 04:42:39 +00:00
crazy-max_diun/README.md

57 lines
3.6 KiB
Markdown
Raw Normal View History

2019-06-04 20:11:54 +00:00
<p align="center"><a href="https://github.com/crazy-max/diun" target="_blank"><img height="128"src="https://raw.githubusercontent.com/crazy-max/diun/master/.res/diun.png"></a></p>
<p align="center">
<a href="https://github.com/crazy-max/diun/releases/latest"><img src="https://img.shields.io/github/release/crazy-max/diun.svg?style=flat-square" alt="GitHub release"></a>
<a href="https://github.com/crazy-max/diun/releases/latest"><img src="https://img.shields.io/github/downloads/crazy-max/diun/total.svg?style=flat-square" alt="Total downloads"></a>
<a href="https://travis-ci.com/crazy-max/diun"><img src="https://img.shields.io/travis/com/crazy-max/diun/master.svg?style=flat-square" alt="Build Status"></a>
2019-06-04 20:22:31 +00:00
<a href="https://hub.docker.com/r/crazymax/diun/"><img src="https://img.shields.io/badge/dynamic/json.svg?label=docker%20tag&query=$.results[1].name&url=https://hub.docker.com/v2/repositories/crazymax/diun/tags&style=flat-square" alt="Docker Tag"></a>
2019-06-04 20:11:54 +00:00
<a href="https://hub.docker.com/r/crazymax/diun/"><img src="https://img.shields.io/docker/stars/crazymax/diun.svg?style=flat-square" alt="Docker Stars"></a>
<a href="https://hub.docker.com/r/crazymax/diun/"><img src="https://img.shields.io/docker/pulls/crazymax/diun.svg?style=flat-square" alt="Docker Pulls"></a>
<br /><a href="https://quay.io/repository/crazymax/diun"><img src="https://quay.io/repository/crazymax/diun/status?style=flat-square" alt="Docker Repository on Quay"></a>
<a href="https://goreportcard.com/report/github.com/crazy-max/diun"><img src="https://goreportcard.com/badge/github.com/crazy-max/diun?style=flat-square" alt="Go Report"></a>
2019-06-09 18:02:14 +00:00
<a href="https://www.codacy.com/app/crazy-max/diun"><img src="https://img.shields.io/codacy/grade/f2ef980c87d247ce8a8dbc98a8f4f434.svg?style=flat-square" alt="Code Quality"></a>
2019-07-25 01:11:18 +00:00
<br /><a href="https://www.patreon.com/crazymax"><img src="https://img.shields.io/badge/donate-patreon-fb664e.svg?style=flat-square" alt="Support me on Patreon"></a>
2019-07-29 05:02:10 +00:00
<a href="https://www.paypal.me/crazyws"><img src="https://img.shields.io/badge/donate-paypal-7057ff.svg?style=flat-square" alt="Donate Paypal"></a>
2019-06-04 20:11:54 +00:00
</p>
2019-08-22 19:29:01 +00:00
## About
2019-06-04 20:11:54 +00:00
2019-08-22 19:29:01 +00:00
**Diun** :bell: is a CLI application written in [Go](https://golang.org/) to receive notifications :inbox_tray: when a Docker :whale: image is updated on a Docker registry. With Go, this app can be used across many platforms :game_die: and architectures. This support includes Linux, FreeBSD, macOS and Windows on architectures like amd64, i386, ARM and others.
2019-06-30 20:26:42 +00:00
2019-06-04 20:11:54 +00:00
## Features
* Allow to watch a full Docker repository and report new tags
* Include and exclude filters with regular expression for tags
* Internal cron implementation through go routines
* Worker pool to parallelize analyses
2019-06-30 22:49:30 +00:00
* Allow overriding image os and architecture
2019-06-04 20:11:54 +00:00
* Beautiful email report
* Webhook notification
* Enhanced logging
* Timezone can be changed
2019-08-22 19:22:10 +00:00
* :whale: Official [Docker image available](doc/install/docker.md)
## Documentation
* Install
* [With Docker](doc/install/docker.md)
* [From binary](doc/install/binary.md)
* [Linux service](doc/install/linux-service.md)
* [Usage](doc/usage.md)
* [Configuration](doc/configuration.md)
* [Notifications](doc/notifications.md)
* [TODO](doc/todo.md)
2019-06-04 20:11:54 +00:00
## How can I help ?
All kinds of contributions are welcome :raised_hands:!<br />
The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:<br />
But we're not gonna lie to each other, I'd rather you buy me a beer or two :beers:!
2019-07-25 01:11:18 +00:00
[![Support me on Patreon](.res/patreon.png)](https://www.patreon.com/crazymax)
2019-07-29 05:02:10 +00:00
[![Paypal](.res/paypal-donate.png)](https://www.paypal.me/crazyws)
2019-06-04 20:11:54 +00:00
## License
MIT. See `LICENSE` for more details.