docs: Basic autoupdater documentation

2014-05-26 21:05:37 +02:00 · 2014-05-26 21:05:37 +02:00 · 0bcea780ca
commit 0bcea780ca
parent 0e00f6574d
1 changed files with 39 additions and 0 deletions
--- a/docs/features/autoupdater.rst
+++ b/docs/features/autoupdater.rst
@ -0,0 +1,39 @@
+Autoupdater
+===========
+
+Infrastructure
+--------------
+
+We suggest to have following directory tree accessible via http:
+
+::
+
+    firmware/
+            stable/
+                    sysupgrade/
+                    factory/
+            snapshot/
+                    sysupgrade/
+                    factory/
+            experimental/
+                    sysupgrade/
+                    factory/
+
+The last level is generated by the Gluon build process. Do not forget
+to rename the ``<branch>.manifest`` into ``manifest`` inside of the
+sysupgrade directories.
+
+The server should be available via IPv6.
+
+Command Line
+------------
+
+::
+
+   # Update with some probability 
+   autoupdate
+
+:: 
+
+   # Force Update Check  
+   autoupdater -f