diff --git a/docs/config/db.md b/docs/config/db.md index 26778726..7a465eb6 100644 --- a/docs/config/db.md +++ b/docs/config/db.md @@ -7,8 +7,7 @@ Path to Bolt database file where images manifests are stored. (default `diun.db` !!! example "Config file" ```yaml db: - path: - token: diun.db + path: diun.db ``` !!! abstract "Environment variables" diff --git a/docs/faq.md b/docs/faq.md index 0f5465b9..21699744 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -12,7 +12,7 @@ Or within a container: ```shell $ docker run --rm -it -v "$(pwd)/diun.yml:/diun.yml" \ - crazymax/diun:latest --config /diun.yml --test-notif + crazymax/diun:latest --config /diun.yml --test-notif ``` ## field docker|swarm uses unsupported type: invalid diff --git a/docs/get-started.md b/docs/get-started.md deleted file mode 100644 index f7b5c97f..00000000 --- a/docs/get-started.md +++ /dev/null @@ -1,28 +0,0 @@ -## What is Diun? - -**D**ocker **I**mage **U**pdate **N**otifier is a CLI application written in [Go](https://golang.org/) and delivered as a -[single executable](https://github.com/crazy-max/diun/releases/latest) (and a [Docker image](install/docker.md)) -to receive notifications when a Docker image is updated on a Docker registry. - -With Go, this can be done with an independent binary distribution across all platforms and architectures that Go supports. -This support includes Linux, macOS, and Windows, on architectures like amd64, i386, ARM, PowerPC, and others. - -## Features - -* Allow to watch a 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 -* Allow overriding image os and architecture -* [Docker](providers/docker.md), [Swarm](providers/swarm.md), [Kubernetes](providers/kubernetes.md) -and [File](providers/file.md) providers available -* Get notified through Gotify, Mail, Slack, Telegram and [more](config/index.md#reference) -* Enhanced logging -* Timezone can be changed -* Official [Docker image available](install/docker.md) - -## Next steps - -* [Command line](usage/cli.md) -* [Basic example](usage/basic-example.md) -* [Configuration](config/index.md) diff --git a/docs/index.md b/docs/index.md index 77075b8e..ffe42b12 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,43 @@ +<img src="assets/logo.png" alt="Diun" width="128px" style="display: block; margin-left: auto; margin-right: auto"/> + +<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://github.com/crazy-max/diun/actions?workflow=build"><img src="https://img.shields.io/github/workflow/status/crazy-max/diun/build?label=build&logo=github&style=flat-square" alt="Build Status"></a> + <a href="https://hub.docker.com/r/crazymax/diun/"><img src="https://img.shields.io/docker/stars/crazymax/diun.svg?style=flat-square&logo=docker" 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&logo=docker" alt="Docker Pulls"></a> + <br /><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> + <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> + <a href="https://codecov.io/gh/crazy-max/diun"><img src="https://img.shields.io/codecov/c/github/crazy-max/diun?logo=codecov&style=flat-square" alt="Codecov"></a> + <a href="https://github.com/sponsors/crazy-max"><img src="https://img.shields.io/badge/sponsor-crazy--max-181717.svg?logo=github&style=flat-square" alt="Become a sponsor"></a> + <a href="https://www.paypal.me/crazyws"><img src="https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal&style=flat-square" alt="Donate Paypal"></a> +</p> + --- -template: home.html -title: Diun ---- + +## What is Diun? + +**D**ocker **I**mage **U**pdate **N**otifier is a CLI application written in [Go](https://golang.org/) and delivered as a +[single executable](https://github.com/crazy-max/diun/releases/latest) (and a [Docker image](install/docker.md)) +to receive notifications when a Docker image is updated on a Docker registry. + +With Go, this can be done with an independent binary distribution across all platforms and architectures that Go supports. +This support includes Linux, macOS, and Windows, on architectures like amd64, i386, ARM, PowerPC, and others. + +## Features + +* Allow to watch a 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 +* Allow overriding image os and architecture +* [Docker](providers/docker.md), [Swarm](providers/swarm.md), [Kubernetes](providers/kubernetes.md) +and [File](providers/file.md) providers available +* Get notified through Gotify, Mail, Slack, Telegram and [more](config/index.md#reference) +* Enhanced logging +* Timezone can be changed +* Official [Docker image available](install/docker.md) + +## License + +This project is licensed under the terms of the MIT license. diff --git a/docs/install/docker.md b/docs/install/docker.md index 032216e8..53580c5a 100644 --- a/docs/install/docker.md +++ b/docs/install/docker.md @@ -66,18 +66,18 @@ Or use the following command: ```shell $ docker run -d --name diun \ - -e "TZ=Europe/Paris" \ - -e "LOG_LEVEL=info" \ - -e "LOG_JSON=false" \ - -e "DIUN_WATCH_WORKERS=20" \ - -e "DIUN_WATCH_SCHEDULE=*/30 * * * *" \ - -e "DIUN_PROVIDERS_DOCKER=true" \ - -e "DIUN_PROVIDERS_DOCKER_WATCHSTOPPED=true" \ - -v "$(pwd)/data:/data" \ - -v "/var/run/docker.sock:/var/run/docker.sock" \ - -l "diun.enable=true" \ - -l "diun.watch_repo=true" \ - crazymax/diun:latest + -e "TZ=Europe/Paris" \ + -e "LOG_LEVEL=info" \ + -e "LOG_JSON=false" \ + -e "DIUN_WATCH_WORKERS=20" \ + -e "DIUN_WATCH_SCHEDULE=*/30 * * * *" \ + -e "DIUN_PROVIDERS_DOCKER=true" \ + -e "DIUN_PROVIDERS_DOCKER_WATCHSTOPPED=true" \ + -v "$(pwd)/data:/data" \ + -v "/var/run/docker.sock:/var/run/docker.sock" \ + -l "diun.enable=true" \ + -l "diun.watch_repo=true" \ + crazymax/diun:latest ``` To upgrade your installation to the latest release: diff --git a/docs/overrides/home.html b/docs/overrides/home.html deleted file mode 100644 index fa5cf64f..00000000 --- a/docs/overrides/home.html +++ /dev/null @@ -1,170 +0,0 @@ -{% extends "main.html" %} - -<!-- Render hero under tabs --> -{% block tabs %} -{{ super() }} - -<!-- Additional styles for landing page --> -<style> - - /* Application header should be static for the landing page */ - .md-header { - position: initial; - } - - /* Remove spacing, as we cannot hide it completely */ - .md-main__inner { - margin: 0; - } - - /* Hide main content for now */ - .md-content { - display: none; - } - - /* Gradient background + blob */ - .tx-container { - padding-top: 1rem; - background: - url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 1123 258'><path d='M1124,2c0,0 0,256 0,256l-1125,0l0,-48c0,0 16,5 55,5c116,0 197,-92 325,-92c121,0 114,46 254,46c140,0 214,-167 572,-166Z' style='fill: white' /></svg>") no-repeat bottom, - linear-gradient( - to bottom, - var(--md-primary-fg-color), - hsla(280deg, 67%, 55%, 1) 99%, - white 99% - ); - } - - /* Set inverted text color on hero */ - .tx-hero { - margin: 0 .8rem; - color: var(--md-primary-bg-color); - } - - /* Make main headline thicker */ - .tx-hero h1 { - margin-bottom: 1rem; - color: currentColor; - font-weight: 700; - } - - /* Ensure that blob doesn't overlap buttons */ - .tx-hero__content { - padding-bottom: 6rem; - } - - /* Adjust spacing of buttons and invert them */ - .tx-hero .md-button { - margin-top: .5rem; - margin-right: .5rem; - color: var(--md-primary-bg-color); - } - - /* Invert primary button */ - .tx-hero .md-button--primary { - background-color: var(--md-primary-bg-color); - color: hsla(280deg, 37%, 48%, 1); - border-color: var(--md-primary-bg-color); - } - - /* Invert hover and focus button states */ - .tx-hero .md-button:hover, - .tx-hero .md-button:focus { - background-color: var(--md-accent-fg-color); - color: var(--md-default-bg-color); - border-color: var(--md-accent-fg-color); - } - - @media screen and (max-width:70em) { - .tx-hero h1 { - font-size: 1.4rem - } - - .tx-hero__image { - text-align: center; - } - - .tx-hero__image img { - max-width: 10rem; - } - } - - @media screen and (min-width:70em) { - .md-sidebar--secondary { - display: none - } - - .tx-hero { - display: flex; - align-items: stretch - } - - .tx-hero__content { - max-width: 30rem; - margin-top: 3.5rem; - padding-bottom: 14vw - } - - .tx-hero__image { - order: 1; - margin-left: auto; - margin-top: 3.5rem; - } - - .tx-hero__image img { - max-width: 15rem; - } - } - - @media screen and (min-width:76.25em) { - .md-sidebar--primary { - display: none - } - - .tx-hero__image { - margin-left: auto; - } - - .tx-hero__image img { - max-width: 20rem; - } - } - - .tx-hero .capitalize { - font-weight: bold; - font-size: 1.4em; - } -</style> - -<!-- Hero for landing page --> -<section class="tx-container"> - <div class="md-grid md-typeset"> - <div class="tx-hero"> - - <!-- Hero image --> - <div class="tx-hero__image"> - <img src="assets/logo.png" alt="" draggable="false"> - </div> - - <!-- Hero content --> - <div class="tx-hero__content"> - <h1>Diun</h1> - <p><span class="capitalize">D</span> ocker <span class="capitalize">I</span> mage <span class="capitalize">U</span> pdate <span class="capitalize">N</span> otifier</p> - <p>{{ config.site_description }}.</p> - <a href="{{ page.next_page.url | url }}" title="{{ page.next_page.title | striptags }}" class="md-button md-button--primary"> - Get started - </a> - <a href="{{ config.repo_url }}" title="{{ lang.t('source.link.title') }}" class="md-button"> - Go to GitHub - </a> - </div> - </div> - </div> -</section> -{% endblock %} - -<!-- Content --> -{% block content %}{% endblock %} - -<!-- Application footer --> -{% block footer %}{% endblock %} diff --git a/docs/overrides/main.html b/docs/overrides/main.html index 6ca8c550..387f5a59 100644 --- a/docs/overrides/main.html +++ b/docs/overrides/main.html @@ -1,8 +1,5 @@ {% extends "base.html" %} -<!-- Custom front matter --> -{% block extrahead %} - <!-- Determine title --> {% set title = config.site_name %} {% if page and page.title and not page.is_homepage %} @@ -12,20 +9,7 @@ <!-- assets absolute URL --> {% set assets = config.site_url ~ 'assets' %} -<!-- Some meta tags --> -<link rel="apple-touch-icon-precomposed" sizes="57x57" href="{{ assets }}/meta/apple-touch-icon-57x57.png"> -<link rel="apple-touch-icon-precomposed" sizes="114x114" href="{{ assets }}/meta/apple-touch-icon-114x114.png"> -<link rel="apple-touch-icon-precomposed" sizes="72x72" href="{{ assets }}/meta/apple-touch-icon-72x72.png"> -<link rel="apple-touch-icon-precomposed" sizes="144x144" href="{{ assets }}/meta/apple-touch-icon-144x144.png"> -<link rel="apple-touch-icon-precomposed" sizes="60x60" href="{{ assets }}/meta/apple-touch-icon-60x60.png"> -<link rel="apple-touch-icon-precomposed" sizes="120x120" href="{{ assets }}/meta/apple-touch-icon-120x120.png"> -<link rel="apple-touch-icon-precomposed" sizes="76x76" href="{{ assets }}/meta/apple-touch-icon-76x76.png"> -<link rel="apple-touch-icon-precomposed" sizes="152x152" href="{{ assets }}/meta/apple-touch-icon-152x152.png"> -<link rel="icon" type="image/png" href="{{ assets }}/meta/favicon-196x196.png" sizes="196x196"> -<link rel="icon" type="image/png" href="{{ assets }}/meta/favicon-96x96.png" sizes="96x96"> -<link rel="icon" type="image/png" href="{{ assets }}/meta/favicon-32x32.png" sizes="32x32"> -<link rel="icon" type="image/png" href="{{ assets }}/meta/favicon-16x16.png" sizes="16x16"> -<link rel="icon" type="image/png" href="{{ assets }}/meta/favicon-128.png" sizes="128x128"> +{% block site_meta %} <meta name="application-name" content="{{ config.site_name }}"> <meta name="msapplication-TileColor" content="#FFFFFF"> <meta name="msapplication-TileImage" content="{{ assets }}/meta/mstile-144x144.png"> @@ -49,6 +33,22 @@ <meta name="twitter:image" content="{{ assets }}/meta/card.png"> {% endblock %} +{% block extrahead %} +<link rel="apple-touch-icon-precomposed" sizes="57x57" href="{{ assets }}/meta/apple-touch-icon-57x57.png"> +<link rel="apple-touch-icon-precomposed" sizes="114x114" href="{{ assets }}/meta/apple-touch-icon-114x114.png"> +<link rel="apple-touch-icon-precomposed" sizes="72x72" href="{{ assets }}/meta/apple-touch-icon-72x72.png"> +<link rel="apple-touch-icon-precomposed" sizes="144x144" href="{{ assets }}/meta/apple-touch-icon-144x144.png"> +<link rel="apple-touch-icon-precomposed" sizes="60x60" href="{{ assets }}/meta/apple-touch-icon-60x60.png"> +<link rel="apple-touch-icon-precomposed" sizes="120x120" href="{{ assets }}/meta/apple-touch-icon-120x120.png"> +<link rel="apple-touch-icon-precomposed" sizes="76x76" href="{{ assets }}/meta/apple-touch-icon-76x76.png"> +<link rel="apple-touch-icon-precomposed" sizes="152x152" href="{{ assets }}/meta/apple-touch-icon-152x152.png"> +<link rel="icon" type="image/png" href="{{ assets }}/meta/favicon-196x196.png" sizes="196x196"> +<link rel="icon" type="image/png" href="{{ assets }}/meta/favicon-96x96.png" sizes="96x96"> +<link rel="icon" type="image/png" href="{{ assets }}/meta/favicon-32x32.png" sizes="32x32"> +<link rel="icon" type="image/png" href="{{ assets }}/meta/favicon-16x16.png" sizes="16x16"> +<link rel="icon" type="image/png" href="{{ assets }}/meta/favicon-128.png" sizes="128x128"> +{% endblock %} + <!-- Announcement bar --> {% block announce %} <style> diff --git a/mkdocs.yml b/mkdocs.yml index 6433ac36..9d82ae93 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -71,7 +71,6 @@ google_analytics: nav: - Home: index.md - - Get started: get-started.md - Installation: - With Docker: install/docker.md - From binary: install/binary.md