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 @@ +Diun + +

+ GitHub release + Total downloads + Build Status + Docker Stars + Docker Pulls +
Go Report + Code Quality + Codecov + Become a sponsor + Donate Paypal +

+ --- -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" %} - - -{% block tabs %} -{{ super() }} - - - - - -
-
-
- - -
- -
- - -
-

Diun

-

D ocker I mage U pdate N otifier

-

{{ config.site_description }}.

- - Get started - - - Go to GitHub - -
-
-
-
-{% endblock %} - - -{% block content %}{% endblock %} - - -{% 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" %} - -{% block extrahead %} - {% set title = config.site_name %} {% if page and page.title and not page.is_homepage %} @@ -12,20 +9,7 @@ {% set assets = config.site_url ~ 'assets' %} - - - - - - - - - - - - - - +{% block site_meta %} @@ -49,6 +33,22 @@ {% endblock %} +{% block extrahead %} + + + + + + + + + + + + + +{% endblock %} + {% block announce %}