From 3d3b809347c98ec827687ed3fd6f9f935261536f Mon Sep 17 00:00:00 2001 From: Markus Unterwaditzer Date: Sat, 6 Sep 2014 22:19:57 +0200 Subject: [PATCH 1/3] Rewrite deployment docs --- docs/deploying/index.rst | 39 ++++++++++++++++-------- docs/quickstart.rst | 65 ++++++++++++++++------------------------ 2 files changed, 52 insertions(+), 52 deletions(-) diff --git a/docs/deploying/index.rst b/docs/deploying/index.rst index bf78275d..f9ca6387 100644 --- a/docs/deploying/index.rst +++ b/docs/deploying/index.rst @@ -3,18 +3,33 @@ Deployment Options ================== -Depending on what you have available there are multiple ways to run -Flask applications. You can use the builtin server during development, -but you should use a full deployment option for production applications. -(Do not use the builtin development server in production.) Several -options are available and documented here. - -If you have a different WSGI server look up the server documentation -about how to use a WSGI app with it. Just remember that your -:class:`Flask` application object is the actual WSGI application. - -For hosted options to get up and running quickly, see -:ref:`quickstart_deployment` in the Quickstart. +Flask's builtin server is lightweight and easy to use, but it has multiple +problems which you don't want to face in production. With default settings, it +can handle only one request at a time, and even if you manage to circumvent +this problem, it has too many scaling problems that would make it unsuitable +for production. **Do not use the builtin development server in production**. +Some of the options available for properly running Flask in production are +documented here. + +If you want to deploy your Flask application to a WSGI server not listed here, +look up the server documentation about how to use a WSGI app with it. Just +remember that your :class:`Flask` application object is the actual WSGI +application. + + +Hosted options +-------------- + +- `Deploying Flask on Heroku `_ +- `Deploying WSGI on dotCloud `_ + with `Flask-specific notes `_ +- `Deploying Flask on Webfaction `_ +- `Deploying Flask on Google App Engine `_ +- `Sharing your Localhost Server with Localtunnel `_ + + +Self-hosted options +------------------- .. toctree:: :maxdepth: 2 diff --git a/docs/quickstart.rst b/docs/quickstart.rst index accb942f..54cd4bf5 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -20,25 +20,7 @@ A minimal Flask application looks something like this:: def hello_world(): return 'Hello World!' -Just save it as `hello.py` (or something similar) and run it with your Python -interpreter. Make sure to not call your application `flask.py` because this -would conflict with Flask itself. - -To run the application you can either use the ``flask`` command or -python's ``-m`` switch with Flask:: - - $ flask -a hello run - * Running on http://127.0.0.1:5000/ - -or alternatively:: - - $ python -m flask -a hello run - * Running on http://127.0.0.1:5000/ - -Now head over to `http://127.0.0.1:5000/ `_, and you -should see your hello world greeting. - -So what did that code do? +So what does that code do? 1. First we imported the :class:`~flask.Flask` class. An instance of this class will be our WSGI application. @@ -54,10 +36,27 @@ So what did that code do? 4. The function is given a name which is also used to generate URLs for that particular function, and returns the message we want to display in the user's browser. -5. Finally we use the Flask development server to run the local server - with our application. -To stop the server, hit control-C. +Just save it as `hello.py` (or something similar). Make sure to not call your +application `flask.py` because this would conflict with Flask itself. + +To run the application you can either use the ``flask`` command or +python's ``-m`` switch with Flask:: + + $ flask -a hello run + * Running on http://127.0.0.1:5000/ + +or alternatively:: + + $ python -m flask -a hello run + * Running on http://127.0.0.1:5000/ + +This launches a very simple builtin server, which is good enough for testing +but probably not what you want to use in production. For deployment options see +:ref:`deployment`. + +Now head over to `http://127.0.0.1:5000/ `_, and you +should see your hello world greeting. To stop the server, hit control-C. .. _public-server: @@ -76,6 +75,7 @@ To stop the server, hit control-C. This tells your operating system to listen on all public IPs. + What to do if the Server does not Start --------------------------------------- @@ -858,6 +858,8 @@ The attached :attr:`~flask.Flask.logger` is a standard logging documentation `_ for more information. +Read more on :ref:`errorhandling`. + Hooking in WSGI Middlewares --------------------------- @@ -869,24 +871,7 @@ can do it like this:: from werkzeug.contrib.fixers import LighttpdCGIRootFix app.wsgi_app = LighttpdCGIRootFix(app.wsgi_app) -.. _quickstart_deployment: - Deploying to a Web Server ------------------------- -Ready to deploy your new Flask app? To wrap up the quickstart, you can -immediately deploy to a hosted platform, all of which offer a free plan for -small projects: - -- `Deploying Flask on Heroku `_ -- `Deploying WSGI on dotCloud `_ - with `Flask-specific notes `_ - -Other places where you can host your Flask app: - -- `Deploying Flask on Webfaction `_ -- `Deploying Flask on Google App Engine `_ -- `Sharing your Localhost Server with Localtunnel `_ - -If you manage your own hosts and would like to host yourself, see the chapter -on :ref:`deployment`. +Ready to deploy your new Flask app? Go to :ref:`deployment`. From 750fa594d8d29715143891ce3eee74672288d14a Mon Sep 17 00:00:00 2001 From: Markus Unterwaditzer Date: Sat, 6 Sep 2014 23:05:00 +0200 Subject: [PATCH 2/3] Shorten paragraph about builtin server --- docs/deploying/index.rst | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/docs/deploying/index.rst b/docs/deploying/index.rst index f9ca6387..60b239f8 100644 --- a/docs/deploying/index.rst +++ b/docs/deploying/index.rst @@ -3,13 +3,10 @@ Deployment Options ================== -Flask's builtin server is lightweight and easy to use, but it has multiple -problems which you don't want to face in production. With default settings, it -can handle only one request at a time, and even if you manage to circumvent -this problem, it has too many scaling problems that would make it unsuitable -for production. **Do not use the builtin development server in production**. -Some of the options available for properly running Flask in production are -documented here. +While lightweight and easy to use, **Flask's built-in server is not suitable +for production** as it doesn't scale well and by default serves only one +request at a time. Some of the options available for properly running Flask in +production are documented here. If you want to deploy your Flask application to a WSGI server not listed here, look up the server documentation about how to use a WSGI app with it. Just From 5c6d789e7b2ff17f43f82b7ca7c9a6410ee7c358 Mon Sep 17 00:00:00 2001 From: Markus Unterwaditzer Date: Sun, 26 Oct 2014 02:01:42 +0200 Subject: [PATCH 3/3] Fix broken link --- docs/quickstart.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 54cd4bf5..f942dc6f 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -858,7 +858,7 @@ The attached :attr:`~flask.Flask.logger` is a standard logging documentation `_ for more information. -Read more on :ref:`errorhandling`. +Read more on :ref:`application-errors`. Hooking in WSGI Middlewares ---------------------------