Merge pull request #405 from diracdeltas/doc/nginx-dvsni

Update docs to reflect nginx support

README.rst

@@ -21,7 +21,7 @@ All you need to do is::
 
   user@www:~$ sudo letsencrypt -d www.example.org auth
 
-and if you have a compatbile web server (Apache), Let's Encrypt can
+and if you have a compatbile web server (Apache or Nginx), Let's Encrypt can
 not only get a new certificate, but also deploy it and configure your
 server automatically!::
 
@@ -60,7 +60,8 @@ Current Features
 
 * web servers supported:
 
-  - apache2.x (tested and working on Ubuntu Linux)
+  - apache/2.x (tested and working on Ubuntu Linux)
+  - nginx/0.8.48+ (tested and mostly working on Ubuntu Linux)
   - standalone (runs its own webserver to prove you control the domain)
 
 * the private key is generated locally on your system
@@ -70,7 +71,7 @@ Current Features
 * can revoke certificates
 * adjustable RSA key bitlength (2048 (default), 4096, ...)
 * optionally can install a http->https redirect, so your site effectively
-  runs https only
+  runs https only (Apache only)
 * fully automated
 * configuration changes are logged and can be reverted using the CLI
 * text and ncurses UI

letsencrypt/client/plugins/nginx/configurator.py

@@ -30,8 +30,6 @@ class NginxConfigurator(common.Plugin):
     # pylint: disable=too-many-instance-attributes,too-many-public-methods
     """Nginx configurator.
 
-    .. warning:: This plugin is a stub, does not support DVSNI yet!
-
     .. todo:: Add proper support for comments in the config. Currently,
         config files modified by the configurator will lose all their comments.
 
@@ -270,7 +268,7 @@ class NginxConfigurator(common.Plugin):
         a 'listen 443 ssl' directive to the server block.
 
         .. todo:: Maybe this should create a new block instead of modifying
-        the existing one?
+            the existing one?
 
         :param vhost: The vhost to add SSL to.
         :type vhost: :class:`~letsencrypt.client.plugins.nginx.obj.VirtualHost`
@@ -554,6 +552,10 @@ class NginxConfigurator(common.Plugin):
 def nginx_restart(nginx_ctl):
     """Restarts the Nginx Server.
 
+    .. todo:: Nginx restart is fatal if the configuration references
+        non-existent SSL cert/key files. Remove references to /etc/letsencrypt
+        before restart.
+
     :param str nginx_ctl: Path to the Nginx binary.
 
     """

letsencrypt/client/plugins/nginx/dvsni.py

@@ -12,9 +12,6 @@ from letsencrypt.client.plugins.nginx.nginxparser import dump
 class NginxDvsni(ApacheDvsni):
     """Class performs DVSNI challenges within the Nginx configurator.
 
-    .. todo:: This is basically copied-and-pasted from the Apache equivalent.
-        It doesn't actually work yet.
-
     :ivar configurator: NginxConfigurator object
     :type configurator: :class:`~nginx.configurator.NginxConfigurator`
 

letsencrypt/client/plugins/nginx/parser.py

@@ -41,9 +41,6 @@ class NginxParser(object):
         directives inside 'http' and 'server' blocks. Note that this only
         reads Nginx files that potentially declare a virtual host.
 
-        .. todo:: Can Nginx 'virtual hosts' be defined somewhere other than in
-        the server context?
-
         :param str filepath: The path to the files to parse, as a glob
 
         """