Skip to content

Loading…

doc improvements for running notebook via secure protocol #730

Merged
merged 3 commits into from

3 participants

@satra

No description provided.

@fperez fperez commented on an outdated diff
IPython/frontend/html/notebook/notebookapp.py
@@ -263,7 +263,12 @@ class IPythonNotebookApp(BaseIPythonApplication):
def start(self):
ip = self.ip if self.ip else '[all ip addresses on your system]'
- self.log.info("The IPython Notebook is running at: http://%s:%i" % (ip, self.port))
+ proto = 'http'
+ if self.certfile:
+ proto = 'https'
+ self.log.info("The IPython Notebook is running at: %s://%s:%i" % (proto,
@fperez IPython member
fperez added a note

Since we're on 2.6, this can be more compactly written in the new form:

proto = 'https' if self.certfile else 'http'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@fperez
IPython member

This is great, thanks! Once this minor fix is made, I'll go ahead and merge.

@ellisonbg ellisonbg merged commit e9402c0 into ipython:master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Showing with 16 additions and 2 deletions.
  1. +4 −1 IPython/frontend/html/notebook/notebookapp.py
  2. +12 −1 docs/source/interactive/htmlnotebook.txt
View
5 IPython/frontend/html/notebook/notebookapp.py
@@ -263,7 +263,10 @@ def initialize(self, argv=None):
def start(self):
ip = self.ip if self.ip else '[all ip addresses on your system]'
- self.log.info("The IPython Notebook is running at: http://%s:%i" % (ip, self.port))
+ proto = 'https' if self.certfile else 'http'
+ self.log.info("The IPython Notebook is running at: %s://%s:%i" % (proto,
+ ip,
+ self.port))
ioloop.IOLoop.instance().start()
#-----------------------------------------------------------------------------
View
13 docs/source/interactive/htmlnotebook.txt
@@ -26,8 +26,19 @@ you want inline figures, you must manually select the ``inline`` backend::
$ ipython notebook --pylab=inline
+You can start the notebook to communicate via a secure protocol mode using a
+self-signed certificate by typing::
+
+ $ ipython notebook --certfile=mycert.pem
+
+.. note::
+
+ A self-signed certificate can be generated with openssl. For example:
+
+ openssl req -x509 -nodes -days 365 -newkey rsa:1024 -keyout mycert.pem -out mycert.pem
+
This server uses the same ZeroMQ-based two process kernel architecture as
-the QT Console as well Tornado for serving HTTP requests. Some of the main
+the QT Console as well Tornado for serving HTTP/S requests. Some of the main
features of the Notebook include:
* Display rich data (png/html/latex/svg) in the browser as a result of
Something went wrong with that request. Please try again.