mirror of https://github.com/crazy-max/diun.git synced 2025-04-10 22:00:13 +00:00

* Fix build workflow

* Docs website with mkdocs (#99)

* Fix docs workflow

* Move mkdocs Docker file

* Ignore docs in build workflow

* Update workflows

* Update links

* Move upgrade notes to documentation

Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>

2020-06-19 22:47:17 +00:00

3.5 KiB

Raw Blame History

Installation from binary

Download

Diun binaries are available on [releases]({{ config.repo_url }}releases) page.

Choose the archive matching the destination platform:

[diun_{{ app.version }}darwin_i386.tar.gz]({{ config.repo_url }}releases/download/v{{ app.version }}/diun{{ app.version }}_darwin_i386.tar.gz)
[diun_{{ app.version }}darwin_x86_64.tar.gz]({{ config.repo_url }}/releases/download/v{{ app.version }}/diun{{ app.version }}_darwin_x86_64.tar.gz)
[diun_{{ app.version }}freebsd_i386.tar.gz]({{ config.repo_url }}/releases/download/v{{ app.version }}/diun{{ app.version }}_freebsd_i386.tar.gz)
[diun_{{ app.version }}freebsd_x86_64.tar.gz]({{ config.repo_url }}/releases/download/v{{ app.version }}/diun{{ app.version }}_freebsd_x86_64.tar.gz)
[diun_{{ app.version }}linux_arm64.tar.gz]({{ config.repo_url }}/releases/download/v{{ app.version }}/diun{{ app.version }}_linux_arm64.tar.gz)
[diun_{{ app.version }}linux_armv6.tar.gz]({{ config.repo_url }}/releases/download/v{{ app.version }}/diun{{ app.version }}_linux_armv6.tar.gz)
[diun_{{ app.version }}linux_armv7.tar.gz]({{ config.repo_url }}/releases/download/v{{ app.version }}/diun{{ app.version }}_linux_armv7.tar.gz)
[diun_{{ app.version }}linux_i386.tar.gz]({{ config.repo_url }}/releases/download/v{{ app.version }}/diun{{ app.version }}_linux_i386.tar.gz)
[diun_{{ app.version }}linux_x86_64.tar.gz]({{ config.repo_url }}/releases/download/v{{ app.version }}/diun{{ app.version }}_linux_x86_64.tar.gz)
[diun_{{ app.version }}windows_i386.zip]({{ config.repo_url }}/releases/download/v{{ app.version }}/diun{{ app.version }}_windows_i386.zip)
[diun_{{ app.version }}windows_x86_64.zip]({{ config.repo_url }}/releases/download/v{{ app.version }}/diun{{ app.version }}_windows_x86_64.zip)

And extract diun:

$ wget -qO- {{ config.repo_url }}releases/download/v{{ app.version }}/diun_{{ app.version }}_linux_x86_64.tar.gz | tar -zxvf - diun

After getting the binary, it can be tested with ./diun --help command and moved to a permanent location.

Server configuration

Steps below are the recommended server configuration.

Prepare environment

Create user to run diun (ex. diun)

$ groupadd diun
$ useradd -s /bin/false -d /bin/null -g diun diun

Create required directory structure

$ mkdir -p /var/lib/diun
$ chown diun:diun /var/lib/diun/
$ chmod -R 750 /var/lib/diun/
$ mkdir /etc/diun
$ chown diun:diun /etc/diun
$ chmod 770 /etc/diun

Configuration

Create your first configuration file in /etc/diun/diun.yml and type:

$ chown diun:diun /etc/diun/diun.yml
$ chmod 644 /etc/diun/diun.yml

!!! note Not required if you want to only rely on environment variables

Copy binary to global location

$ cp diun /usr/local/bin/diun

Running Diun

After the above steps, two options to run Diun:

1. Creating a service file (recommended)

See how to create Linux service to start Diun automatically.

2. Running from terminal

$ DIUN_DB_PATH=/var/lib/diun/diun.db /usr/local/bin/diun --config /etc/diun/diun.yml

Updating to a new version

You can update to a new version of Diun by stopping it, replacing the binary at /usr/local/bin/diun and restarting the instance.

If you have carried out the installation steps as described above, the binary should have the generic name diun. Do not change this, i.e. to include the version number.

3.5 KiB Raw Blame History