setup howto
[noxon-gateway.git] / README.rst
index 1d3d3a307a586205982ff37470a006f56f067dc9..89b7d8dba14f2aa7a22a8efa54f03883453d87d5 100644 (file)
@@ -153,6 +153,8 @@ executable file
   rules as for ``.txt`` files.
 
   You can use this to show the current time within the directory listing.
+``nocache``
+  Disables menu caching.
 
 File extensions get removed for display purposes.
 
@@ -181,10 +183,47 @@ Would render as::
 (given that ``01_temp.auto.sh`` outputs the temperature string)
 
 
+Caching
+=======
+When going back in the menu strucutre with the left arrow button,
+Noxon iRadios display a cached version of the menu.
+
+If you do not want this - because a script modified values that are
+displayed in the parent menu, or because the script that displays
+the time should always be run - you may disable caching.
+
+Caching is disabled when a file named ``nocache`` is found in the directory.
+
+
 =====
 Setup
 =====
 
+Basic setup
+===========
+#. You need a web server (Apache) with PHP.
+
+   Using nginx, lighttpd or others is possible, but you need to translate
+   the redirects in the ``www/.htaccess`` file into their respective format.
+
+#. Clone the Git repository of this noxon-gateway software::
+
+     $ git clone https://git.cweiske.de/noxon-gateway.git
+
+#. Configure your network's DNS server/router, see the "Hosts" section.
+
+#. Point your web server's (virtual host) document root to the ``www``
+   directory.
+
+   Let your web server handle the domain names.
+
+#. Open http://gatekeeper.my-noxon.net/ in your browser.
+   You should see the noxon gateway software.
+
+   If your browser supports XSLT, you will not see XML, but clickable HTML
+   links.
+
+
 Hosts
 =====
 The following hosts must point to your server and be handled
@@ -228,6 +267,8 @@ About noxon-gateway
 
 Homepage
 ========
+``noxon-gateway`` lives at http://cweiske.de/noxon-gateway.htm
+
 The source code is available at http://git.cweiske.de/noxon-gateway.git/
 and mirrored at https://github.com/cweiske/noxon-gateway.