From 85b3e62b43afd87d2f2451f43d867560540fc544 Mon Sep 17 00:00:00 2001 From: Shulhan Date: Sun, 24 Jan 2021 16:35:11 +0700 Subject: README: add section to show the screenshots and usage of web interface The screenshots images point to the latest image in the master branch. In the man page, the screenshot will be displayed as text. --- README.adoc | 37 ++++++++++++++++++++++++++++ _doc/images/Screenshot_wui_environment.png | Bin 0 -> 158861 bytes _doc/images/Screenshot_wui_frontpage.png | Bin 0 -> 344669 bytes _doc/images/Screenshot_wui_hosts_blocks.png | Bin 0 -> 198326 bytes _doc/images/Screenshot_wui_hosts_d.png | Bin 0 -> 125782 bytes _doc/images/Screenshot_wui_zone_d.png | Bin 0 -> 91905 bytes rescached.1.gz | Bin 5619 -> 5919 bytes 7 files changed, 37 insertions(+) create mode 100644 _doc/images/Screenshot_wui_environment.png create mode 100644 _doc/images/Screenshot_wui_frontpage.png create mode 100644 _doc/images/Screenshot_wui_hosts_blocks.png create mode 100644 _doc/images/Screenshot_wui_hosts_d.png create mode 100644 _doc/images/Screenshot_wui_zone_d.png diff --git a/README.adoc b/README.adoc index f9debc7..91f503f 100644 --- a/README.adoc +++ b/README.adoc @@ -5,6 +5,7 @@ M. Shulhan :doctype: manpage :mansource: rescached :manmanual: rescached +:toc: == NAME @@ -363,6 +364,42 @@ If you see number "4" in request line, "< request: 4", thats indicated that request is from HTTPS connection and its working. +== WEB USER INTERFACE + +The rescached service provide a web user interface that can be accessed at +http://127.0.0.1:5380. + +.Screenshot of front page +image:https://raw.githubusercontent.com/shuLhan/rescached-go/master/_doc/images/Screenshot_wui_frontpage.png[width=75%]. + +The front page allow user to monitor active caches, query the caches, and +removing the caches. + +.Screenshot of Environment page +image:https://raw.githubusercontent.com/shuLhan/rescached-go/master/_doc/images/Screenshot_wui_environment.png[width=75%]. + +The Environment page allow user to modify the rescached configuration on the +fly. + +.Screenshot of Hosts Blocks page +image:https://raw.githubusercontent.com/shuLhan/rescached-go/master/_doc/images/Screenshot_wui_hosts_blocks.png[width=75%]. + +The Hosts Blocks page allow user to enable or disable the external sources of +hosts blocks list. + +.Screenshot of Hosts.d page +image:https://raw.githubusercontent.com/shuLhan/rescached-go/master/_doc/images/Screenshot_wui_hosts_d.png[width=75%]. + +The Hosts.d page allow user to manage hosts file, creating new hosts file, +create new record, or delete a record. + +.Screenshot of Zone.d page +image:https://raw.githubusercontent.com/shuLhan/rescached-go/master/_doc/images/Screenshot_wui_zone_d.png[width=75%]. + +The Zone.d page allow user manage zone file, creating new zone file, adding or +deleting new resource record in the zone file. + + == EXIT STATUS Upon success, +rescached+ will return 0, or 1 otherwise. diff --git a/_doc/images/Screenshot_wui_environment.png b/_doc/images/Screenshot_wui_environment.png new file mode 100644 index 0000000..0e8c60d Binary files /dev/null and b/_doc/images/Screenshot_wui_environment.png differ diff --git a/_doc/images/Screenshot_wui_frontpage.png b/_doc/images/Screenshot_wui_frontpage.png new file mode 100644 index 0000000..0ee949b Binary files /dev/null and b/_doc/images/Screenshot_wui_frontpage.png differ diff --git a/_doc/images/Screenshot_wui_hosts_blocks.png b/_doc/images/Screenshot_wui_hosts_blocks.png new file mode 100644 index 0000000..7eaebe2 Binary files /dev/null and b/_doc/images/Screenshot_wui_hosts_blocks.png differ diff --git a/_doc/images/Screenshot_wui_hosts_d.png b/_doc/images/Screenshot_wui_hosts_d.png new file mode 100644 index 0000000..b096fa0 Binary files /dev/null and b/_doc/images/Screenshot_wui_hosts_d.png differ diff --git a/_doc/images/Screenshot_wui_zone_d.png b/_doc/images/Screenshot_wui_zone_d.png new file mode 100644 index 0000000..52e7913 Binary files /dev/null and b/_doc/images/Screenshot_wui_zone_d.png differ diff --git a/rescached.1.gz b/rescached.1.gz index a41425f..986dd77 100644 Binary files a/rescached.1.gz and b/rescached.1.gz differ -- cgit v1.3