From 8a86948243094138749eabec41f506fd218c336f Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Sat, 19 Oct 2013 22:17:30 -0700 Subject: [PATCH] deduplicated docs / README, add more install instructions --- README.rst | 48 ++++++++++++++++++++---------------------------- docs/admin.rst | 29 +++++++++++++++++++++++++++++ docs/intro.rst | 21 +-------------------- 3 files changed, 50 insertions(+), 48 deletions(-) diff --git a/README.rst b/README.rst index 05f74fc..f035fc7 100644 --- a/README.rst +++ b/README.rst @@ -1,35 +1,27 @@ About nsupdate.info =================== -nsupdate.info is the idea of a really simple single purpose dynamic dns service. -Unlike other dynamic dns services its intention is that you do not -have to click a link every 30 days to keep your domain enabled or other jokes -like this. +http://nsupdate.info is a free dynamic dns service. -nsupdate.info is is intended to be self hostable, but there is also a free -service on http://nsupdate.info/ +nsupdate.info is also the name of the software used to implement it. +If you like, you can use it to host the service on your own server. -Installation -============ +Features +======== -If you haven't already done create and change to a virtualenv for the -installation (here with virtualenvwrapper):: - - mkvirtualenv nsupdate - workon nsupdate - - -Clone the repo and cd into:: - - git clone git@github.com:nsupdate-info/nsupdate.info.git nsupdate - cd nsupdate - - -Then install the requirements:: - - pip install -e . - - -From time to time execute this again to install the newest dependencies. -Maybe in future there will be a PyPi package to install directly with pip. +* Frontend: Dynamic DNS updates via dyndns2 protocol (like supported + by many DSL/cable routers and client software). +* Backend: Uses DYNAMIC DNS UPDATE protocol (RFC 2136) to update compatible + nameservers like BIND, PowerDNS and others (the nameserver itself is NOT + included). +* Easy and simple web interface. +* Multiple Hosts per user +* Add own domains / nameservers (public or only for yourself) +* Supports IP v4 and v6 +* Manual IP updates via web interface +* Shows time since last update via api +* Made with security in mind +* No nagging, no spamming, trying to not annoy users +* Free and Open Source Software +* Made with Python and Django diff --git a/docs/admin.rst b/docs/admin.rst index 45b19da..3593e5e 100644 --- a/docs/admin.rst +++ b/docs/admin.rst @@ -2,3 +2,32 @@ Administrating the service ========================== +Installation +============ + +Create and activate a virtualenv for the installation (here with virtualenvwrapper):: + + mkvirtualenv nsupdate + workon nsupdate + + +Clone the repo and cd into:: + + git clone git@github.com:nsupdate-info/nsupdate.info.git nsupdate + cd nsupdate + + +Then install the software with requirements to your virtual env:: + + pip install -e . + + +To create and initialize the database, use:: + + python manage.py syncdb + python manage.py migrate + + +To start the development server:: + + python manage.py runserver diff --git a/docs/intro.rst b/docs/intro.rst index 04d8b79..b58ac85 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -2,23 +2,4 @@ Introduction ============ -About nsupdate.info -=================== - -http://nsupdate.info is a free dynamic dns service. - -nsupdate.info is also the name of the software used to implement it, -it is sort of a gateway between dyndns2 protocol and dynamic dns update protocol. - -If you like, you can use it to host the service on your own server. - -Features -======== - -* Easy and simple web interface. -* Supports popular dyndns2 API (like supported by many DSL/cable routers - and client software). -* Uses DYNAMIC DNS UPDATE protocol (RFC 2136) to update compatible nameservers like - BIND, PowerDNS and others (the nameserver itself is NOT included). -* Built with security and IPv6 in mind. -* Free and Open Source Software, written in Python with Django. +.. include:: ../README.rst