summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2021-01-24 16:35:11 +0700
committerShulhan <ms@kilabit.info>2021-01-24 16:51:00 +0700
commit85b3e62b43afd87d2f2451f43d867560540fc544 (patch)
tree2cd3fa197747b52287fd1c98b1d131968520c1ab
parentb499fab06dd38324ad2fc5a65ec536a4ab4df1a8 (diff)
downloadrescached-85b3e62b43afd87d2f2451f43d867560540fc544.tar.xz
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.
-rw-r--r--README.adoc37
-rw-r--r--_doc/images/Screenshot_wui_environment.pngbin0 -> 158861 bytes
-rw-r--r--_doc/images/Screenshot_wui_frontpage.pngbin0 -> 344669 bytes
-rw-r--r--_doc/images/Screenshot_wui_hosts_blocks.pngbin0 -> 198326 bytes
-rw-r--r--_doc/images/Screenshot_wui_hosts_d.pngbin0 -> 125782 bytes
-rw-r--r--_doc/images/Screenshot_wui_zone_d.pngbin0 -> 91905 bytes
-rw-r--r--rescached.1.gzbin5619 -> 5919 bytes
7 files changed, 37 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc
index f9debc7..91f503f 100644
--- a/README.adoc
+++ b/README.adoc
@@ -5,6 +5,7 @@ M. Shulhan <ms@kilabit.info>
: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
--- /dev/null
+++ b/_doc/images/Screenshot_wui_environment.png
Binary files differ
diff --git a/_doc/images/Screenshot_wui_frontpage.png b/_doc/images/Screenshot_wui_frontpage.png
new file mode 100644
index 0000000..0ee949b
--- /dev/null
+++ b/_doc/images/Screenshot_wui_frontpage.png
Binary files 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
--- /dev/null
+++ b/_doc/images/Screenshot_wui_hosts_blocks.png
Binary files 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
--- /dev/null
+++ b/_doc/images/Screenshot_wui_hosts_d.png
Binary files 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
--- /dev/null
+++ b/_doc/images/Screenshot_wui_zone_d.png
Binary files differ
diff --git a/rescached.1.gz b/rescached.1.gz
index a41425f..986dd77 100644
--- a/rescached.1.gz
+++ b/rescached.1.gz
Binary files differ