flo/nsupdate.info
1
0
Fork 0
Code Issues 1 Pull Requests 2 Packages Releases Activity

docs enhancements

Browse Source
This commit is contained in:
Thomas Waldmann 2013-11-08 01:52:52 +01:00
parent 22c44afbe9
commit 0d2184037a
5 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.rst
View File

@ -21,10 +21,12 @@ Features
* Easy and simple web interface. * Easy and simple web interface.
* Multiple Hosts per user * Multiple Hosts per user
* Add own domains / nameservers (public or only for yourself) * Add own domains / nameservers (public or only for yourself)
* Supports IP v4 and v6 * Supports IP v4 and v6, SSL.
* Login with local or remote accounts (google, github, bitbucket, ...
accounts - everything supported by python-social-auth package)
* Manual IP updates via web interface * Manual IP updates via web interface
* Shows time since last update via api * Shows time since last update via api, whether it used SSL or not
* Made with security in mind * Made with security in mind
* No nagging, no spamming, trying to not annoy users * No nagging, no spamming - trying not to annoy users
* Free and Open Source Software * Free and Open Source Software
* Made with Python and Django * Made with Python and Django

6
docs/admin.rst
View File

@ -63,6 +63,11 @@ to the outside world.
Make sure your static files really work. Make sure your static files really work.
Since version 1.6, Django has a nice deployment checklist (make sure stuff
applies to the django version YOU use):
https://docs.djangoproject.com/en/1.6/howto/deployment/checklist/
Configuration Configuration
============= =============
@ -89,6 +94,7 @@ Users who are in the "staff" group (like the one initially created when creating
admin interface (see "Admin" in the same menu as "Logout"). admin interface (see "Admin" in the same menu as "Logout").
But be careful, the Django admin lets you do all sorts of stuff, admins are allowed to shoot themselves. But be careful, the Django admin lets you do all sorts of stuff, admins are allowed to shoot themselves.
Only give Django admin access ("staff" group membership) to highly trusted admins of the service.
Software updates / upgrades Software updates / upgrades

3
docs/project.rst
View File

@ -15,6 +15,9 @@ The initial version of the nsupdate.info software was developed in 48h in the Dj
Project site Project site
============ ============
Source code repository, issue tracker (bugs, ideas about enhancements, todo,
feedback, ...), link to documentation is all there:
https://github.com/nsupdate-info/nsupdate.info https://github.com/nsupdate-info/nsupdate.info

6
docs/security.rst
View File

@ -89,12 +89,12 @@ update client also.
Nameserver Update Key (backend, RFC 2136) Nameserver Update Key (backend, RFC 2136)
----------------------------------------- -----------------------------------------
We currently store this key (which is basically a base64 encoded shared secret) We currently store this key (which is basically a base64 encoded shared secret,
"as is". one per dynamic zone) "as is" into the database ("Domain" records there).
This is somehow critical, but also hard to do better - encryption would only This is somehow critical, but also hard to do better - encryption would only
help very little here as we would need to decrypt the update key before using it, help very little here as we would need to decrypt the update key before using it,
so we would need the unlocked key of that encryption mechanism on the same machine. so we would need the unlocked decryption key on the same machine.
Make sure no unauthorized person gets that key or he/she will be able to update Make sure no unauthorized person gets that key or he/she will be able to update
ANY record in the respective zone / nameserver directly (without going over ANY record in the respective zone / nameserver directly (without going over