X-Git-Url: http://www.wagner.pp.ru/gitweb/?a=blobdiff_plain;f=README.md;fp=README.md;h=721fe2fee741f9e502c638fe007983db22322937;hb=65240923f667eeb18fb688c4591ca22495491d90;hp=9b5f951568721eb5e5b582de4efaa6a28565d634;hpb=d3eaa42a7888d9a95f7d64eb528dd8f84b0a777b;p=oss%2Fdyngo.git

diff --git a/README.md b/README.md
index 9b5f951..721fe2f 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ remembered name.
 But it is not always a case in the world of NATs and VPNs.
 
 If machine always have public IP address, than using some dynamic DNS
-service may help (short of neccessity to use full domain name. But 
+service may help (short of necessity to use full domain name. But 
 ${HOME}/.ssh/config may help). But what if you log into your office
 workstation via corporate VPN, and want ssh back home?
 
@@ -26,5 +26,40 @@ to specified URL.
 
 See [manual page](dyngo.md) for more info.
 
+PRROTOCOL
+=========
+
+**dyngo** uses protocol compatible with dyndns.org, as described 
+pn [help.dyn.com](https://help.dyn.com/remote-access-api/perform-update/
+)
+As different dynamic DNS servers use different path components of URL,
+you should specify URL with path component (up to question mark) in 
+the *server* parameter of configuraton section.
+
+INSTALLATION
+============
+
+**dyngo** is simple script which doesn't require anything but
+python3 with standard library and **ip** utility from iproute (or
+iproute2 on Debian) package, which presents on every modern Linux
+system.
+
+I've even preferred to use
+[urllib](https://docs.python.org/3/library/urllib.request.html#module-urllib.request)
+to [requests](http://docs.python-requests.org/) to eliminate extra
+external dependency.
+
+So, you can just drop **dyngo** somewhere in your filesystem, say in 
+**/usr/local/sbin** and put config into */etc* But **dyngo** should run
+as a service, so you might want to use provided service file.
+
+**dyngo** should run as unprivileged user. But its configuration file
+should, readable for this user, contains somewhat sensitive information
+—  your dyndns passwords. So, don't use common account many untrusted
+code run as such as **nobody** or **www-data**. Better to create special
+user dyngo.
+
+There should be writable directory, writable for this user for
+persistent state database. By default it is /var/lib/dyngo.