Merge pull request #15 from sh4nks/develop

Added some docs.

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/_themes"]
+	path = docs/_themes
+	url = https://github.com/mitsuhiko/flask-sphinx-themes

docs/.gitignore

@@ -0,0 +1 @@
+_build

docs/Makefile

@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FlaskBB.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FlaskBB.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/FlaskBB"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FlaskBB"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/_templates/sidebarintro.html

@@ -0,0 +1,12 @@
+<h3>About</h3>
+<p>
+  FlaskBB is forum software built with Flask. You can very easy create
+  new topics, posts and send other users private messages. It also includes
+  basic administration and moderation tools.
+</p>
+<h3>Useful Links</h3>
+<ul>
+  <li><a href="http://flaskbb.org">FlaskBB Website</a></li>
+  <li><a href="https://github.com/sh4nks/flaskbb">FlaskBB @ github</a></li>
+  <li><a href="https://github.com/sh4nks/flaskbb/issues">Issue Tracker</a></li>
+</ul>

docs/_themes

@@ -0,0 +1 @@
+Subproject commit 1cc44686f0f9dad27cce2c9d16cf42f97bc87dbd

docs/conf.py

@@ -0,0 +1,270 @@
+# -*- coding: utf-8 -*-
+#
+# FlaskBB documentation build configuration file, created by
+# sphinx-quickstart on Fri Feb 14 19:56:59 2014.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('..'))
+sys.path.append(os.path.abspath('_themes'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'FlaskBB'
+copyright = u'2014, sh4nks'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1-dev'
+# The full version, including alpha/beta/rc tags.
+release = '0.1-dev'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'flask'
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = ['_themes']
+html_theme_options = {
+    'index_logo': False,
+}
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+html_sidebars = {
+    'index':    ['sidebarintro.html', 'sourcelink.html', 'searchbox.html'],
+    '**':       ['localtoc.html', 'relations.html',
+                 'sourcelink.html', 'searchbox.html']
+}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = False
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = False
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'FlaskBBdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  ('index', 'FlaskBB.tex', u'FlaskBB Documentation',
+   u'sh4nks', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'flaskbb', u'FlaskBB Documentation',
+     [u'sh4nks'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'FlaskBB', u'FlaskBB Documentation',
+   u'sh4nks', 'FlaskBB', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}

docs/contents.rst.inc

@@ -0,0 +1,7 @@
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 1
+
+   installation

docs/index.rst

@@ -0,0 +1,16 @@
+:orphan:
+
+Welcome to FlaskBB's documentation!
+===================================
+
+FlaskBB is a lightweight forum software in Flask.
+
+
+Links
+-----
+
+`documentation <http://flaskbb.readthedocs.org/en/latest/index.html/>`_
+| `source <http://github.com/sh4nks/flaskbb>`_
+
+
+.. include:: contents.rst.inc

docs/installation.rst

@@ -0,0 +1,318 @@
+Installation
+============
+
+-  `Basic Setup <#basic-setup>`_
+-  `Configuration <#configuration>`_
+-  `Deplyoing <#deploying>`_
+
+
+
+Basic Setup
+===========
+
+Virtualenv Setup
+~~~~~~~~~~~~~~~~
+
+Before you can start, you need to create a `virtualenv`.
+You can install the virtualenvwrapper with your package manager or via pip.
+Be sure that pip is installed. If you don't know how to install pip, have a
+look at their `documentation <http://www.pip-installer.org/en/latest/installing.html>`_.
+
+For example, on archlinux you can install it with
+::
+
+    $ sudo pacman -S python2-virtualenvwrapper
+
+or, if you own a Mac, you can simply install it with
+::
+
+    $ sudo pip install virtualenvwrapper
+
+For more information checkout the  `virtualenvwrapper <http://virtualenvwrapper.readthedocs.org/en/latest/install.html#basic-installation>`_ installation.
+
+After that you can create your virtualenv with
+::
+
+    $ mkvirtualenv -a /path/to/flaskbb -p $(which python2) flaskbb
+
+and you should be switched automatically to your newly created virtualenv.
+To deactivate it you just have to type ``deactivate`` and if you want to work
+on it again, you need to type ``workon flaskbb``.
+
+Required Dependencies
+~~~~~~~~~~~~~~~~~~~~~
+
+Now you can install the required dependencies.
+
+::
+
+     $ pip install -r requirements.txt
+
+
+Optional Dependencies
+~~~~~~~~~~~~~~~~~~~~~~
+
+We have one optional dependency, redis (the python package is installed automatically).
+If you want to use it, be sure that a redis-server is running. If you decide
+to use redis, the `online guests` and `online users` are being tracked by redis,
+else it will only track the `online users` via a simple SQL query.
+
+On Archlinux
+------------
+
+::
+
+    # Install redis
+    $ sudo pacman -S redis
+
+    # Check if redis is already running.
+    $ systemctl status redis
+
+    # If not, start it.
+    $ sudo systemctl start redis
+
+    # Optional: Start redis everytime you boot your machine
+    $ sudo systemctl enable redis
+
+On Debian 7.0 (Wheezy)
+----------------------
+
+::
+
+    # Install redis
+    $ sudo apt-get install redis-server
+
+    # Check if redis is already running.
+    $ service redis-server status
+
+    # If not, start it
+    $ sudo service redis-server start
+
+    # Optional: Start redis everytime you boot your machine
+    # I can't remember if this is done automatically..
+    $ sudo update-rc.d redis-server defaults
+
+
+Configuration
+=============
+
+Before you can start, you need to configure `FlaskBB`.
+
+Development
+~~~~~~~~~~~
+
+For development, you need to copy ``flaskbb/configs/development.py.example`` to
+``flaskbb/configs/development.py``.
+::
+
+    cp flaskbb/configs/development.py.example flaskbb/configs/development.py
+
+The reCAPTCHA keys should work fine on localhost.
+
+
+Production
+~~~~~~~~~~
+
+If you plan, to use `FlaskBB` in a production environment (not recommended at
+the moment, because it's still in development), you need to copy
+``flaskbb/configs/production.py.example`` to ``flaskbb/configs/production.py``.
+::
+
+    cp flaskbb/configs/production.py.example flaskbb/configs/production.py
+
+Now open ``flaskbb/configs/production.py`` with your favourite editor and adjust
+the config variables to your needs.
+
+
+Mail Examples
+~~~~~~~~~~~~~
+
+Both methods are included in the example configs.
+
+Google Mail
+-----------
+
+::
+
+    MAIL_SERVER = "smtp.gmail.com"
+    MAIL_PORT = 465
+    MAIL_USE_SSL = True
+    MAIL_USERNAME = "your_username@gmail.com"
+    MAIL_PASSWORD = "your_password"
+    MAIL_DEFAULT_SENDER = ("Your Name", "your_username@gmail.com")
+
+Local SMTP Server
+-----------------
+
+::
+
+    MAIL_SERVER = "localhost"
+    MAIL_PORT = 25
+    MAIL_USE_SSL = False
+    MAIL_USERNAME = ""
+    MAIL_PASSWORD = ""
+    MAIL_DEFAULT_SENDER = "noreply@example.org"
+
+
+Installation
+============
+
+Now, you should be able to install `FlaskBB` and can run therefore
+::
+
+    python manage.py initflaskbb
+
+Here you are asked about what your username is, which email adress you use
+and last but not least, which password your admin user has (please choose a secure one).
+
+To test if everything worked, run the development server with
+``python manage.py runserver``.
+
+
+Deploying
+=========
+
+I prefer to use supervisor, uWSGI and nginx to deploy my apps, but if you have
+figured out how to deploy it in another way, please let me know, so I
+(or you if you create a pull request) can add it to the documentation.
+
+**NOTE:** I have only used Debian to deploy it, if someone is using a other
+distribution, could you let me know if that works too? `Also, if you have better
+configurations for uWSGI, supervisor or nginx let me know that too.`
+
+
+Supervisor
+~~~~~~~~~~
+
+`Supervisor is a client/server system that allows its users to monitor and
+control a number of processes on UNIX-like operating systems.`
+
+To install `supervisor` on Debian, you need to fire up this command:
+::
+
+    $ sudo apt-get install supervisor
+
+There are two ways to configure supervisor. The first one is, you just put
+the configuration to the end in the ``/etc/supervisor/supervisord.conf`` file.
+
+The second way would be to create a new file in the ``/etc/supervisor/conf.d/``
+directory. For example, such a file could be named ``uwsgi.conf``.
+
+After you have choosen the you way you like, simply put the snippet below in the
+configuration file.
+
+::
+
+    [program:uwsgi]
+    command=/usr/bin/uwsgi --emperor /etc/uwsgi/apps-enabled
+    user=apps
+    stopsignal=QUIT
+    autostart=true
+    autorestart=true
+    redirect_stderr=true
+
+
+uWSGI
+~~~~~
+
+`uWSGI is a web application solution with batteries included.`
+
+To get started with uWSGI, you need to install it first.
+You'll also need the python plugin to serve python apps.
+This can be done with:
+
+::
+
+    $ sudo apt-get install uwsgi uwsgi-plugins-python
+
+For the configuration, you need to create a file in the
+``/etc/uwsgi/apps-available`` directory. In this example, I will call the
+file ``flaskbb.ini``. After that, you can start with configuring it.
+My config looks like this for `flaskbb.org` (see below). As you might have noticed, I'm
+using a own user for my apps whose home directory is located at `/var/apps/`.
+In this directory there are living all my Flask apps.
+
+::
+
+    [uwsgi]
+    base = /var/apps/flaskbb
+    home = /var/apps/.virtualenvs/flaskbb/
+    pythonpath = %(base)
+    socket = 127.0.0.1:30002
+    module = wsgi
+    callable = flaskbb
+    uid = apps
+    gid = apps
+    logto = /var/apps/flaskbb/logs/uwsgi.log
+    plugins = python
+
+
+===============  ==========================  ===============
+**base**         /path/to/flaskbb            The folder where your flaskbb application lives
+**home**         /path/to/virtualenv/folder  The virtualenv folder for your flaskbb application
+**pythonpath**   /path/to/flaskbb            The same as base
+**socket**       socket                      This can be either a ip or the path to a socket (don't forget to change that in your nginx config)
+**module**       wsgi.py                     This is the file located in the root directory from flaskbb (where manage.py lives).
+**callable**     flaskbb                     The callable is application you have created in the ``wsgi.py`` file
+**uid**          your_user                   The user who should be used. **NEVER** use root!
+**gid**          your_group                  The group who should be used.
+**logto**        /path/to/log/file           The path to your uwsgi logfile
+**plugins**      python                      We need the python plugin
+===============  ==========================  ===============
+
+Don't forget to create a symlink to ``/etc/uwsgi/apps-enabled``.
+
+::
+
+    ln -s /etc/uwsgi/apps-available/flaskbb /etc/uwsgi/apps-enabled/flaskbb
+
+
+nginx
+~~~~~
+
+`nginx [engine x] is an HTTP and reverse proxy server,
+as well as a mail proxy server, written by Igor Sysoev.`
+
+The nginx config is pretty straightforward. Again, this is how I use it for
+`FlaskBB`. Just copy the snippet below and paste it to, for example
+``/etc/nginx/sites-available/flaskbb``.
+The only thing left is, that you need to adjust the ``server_name`` to your
+domain and the paths in ``access_log``, ``error_log``. Also, don't forget to
+adjust the paths in the ``alias`` es, as well as the socket adress in ``uwsgi_pass``.
+
+::
+
+    server {
+        listen 80;
+        server_name forums.flaskbb.org;
+
+        access_log /var/log/nginx/access.forums.flaskbb.log;
+        error_log /var/log/nginx/error.forums.flaskbb.log;
+
+        location / {
+            try_files $uri @flaskbb;
+        }
+
+        # Static files
+        location /static {
+           alias /var/apps/flaskbb/flaskbb/static/;
+        }
+
+        location ~ ^/_themes/([^/]+)/(.*)$ {
+            alias /var/apps/flaskbb/flaskbb/themes/$1/static/$2;
+        }
+
+        # robots.txt
+        location /robots.txt {
+            alias /var/apps/flaskbb/flaskbb/static/robots.txt;
+        }
+
+        location @flaskbb {
+            uwsgi_pass 127.0.0.1:30002;
+            include uwsgi_params;
+        }
+    }
+
+
+Like in the `uWSGI <#uwsgi>`_ chapter, don't forget to create a symlink to
+``/etc/nginx/sites-enabled/``.

docs/make.bat

@@ -0,0 +1,242 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	:help
+	echo.Please use `make ^<target^>` where ^<target^> is one of
+	echo.  html       to make standalone HTML files
+	echo.  dirhtml    to make HTML files named index.html in directories
+	echo.  singlehtml to make a single large HTML file
+	echo.  pickle     to make pickle files
+	echo.  json       to make JSON files
+	echo.  htmlhelp   to make HTML files and a HTML help project
+	echo.  qthelp     to make HTML files and a qthelp project
+	echo.  devhelp    to make HTML files and a Devhelp project
+	echo.  epub       to make an epub
+	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+	echo.  text       to make text files
+	echo.  man        to make manual pages
+	echo.  texinfo    to make Texinfo files
+	echo.  gettext    to make PO message catalogs
+	echo.  changes    to make an overview over all changed/added/deprecated items
+	echo.  xml        to make Docutils-native XML files
+	echo.  pseudoxml  to make pseudoxml-XML files for display purposes
+	echo.  linkcheck  to check all external links for integrity
+	echo.  doctest    to run all doctests embedded in the documentation if enabled
+	goto end
+)
+
+if "%1" == "clean" (
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+	del /q /s %BUILDDIR%\*
+	goto end
+)
+
+
+%SPHINXBUILD% 2> nul
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+	goto end
+)
+
+if "%1" == "singlehtml" (
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "htmlhelp" (
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+	goto end
+)
+
+if "%1" == "qthelp" (
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\FlaskBB.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\FlaskBB.ghc
+	goto end
+)
+
+if "%1" == "devhelp" (
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished.
+	goto end
+)
+
+if "%1" == "epub" (
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "latexpdf" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	cd %BUILDDIR%/latex
+	make all-pdf
+	cd %BUILDDIR%/..
+	echo.
+	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "latexpdfja" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	cd %BUILDDIR%/latex
+	make all-pdf-ja
+	cd %BUILDDIR%/..
+	echo.
+	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "text" (
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The text files are in %BUILDDIR%/text.
+	goto end
+)
+
+if "%1" == "man" (
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
+	goto end
+)
+
+if "%1" == "texinfo" (
+	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+	goto end
+)
+
+if "%1" == "gettext" (
+	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.The overview file is in %BUILDDIR%/changes.
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+	goto end
+)
+
+if "%1" == "xml" (
+	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The XML files are in %BUILDDIR%/xml.
+	goto end
+)
+
+if "%1" == "pseudoxml" (
+	%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
+	goto end
+)
+
+:end

flaskbb/configs/development.py.example

@@ -40,12 +40,21 @@ class DevelopmentConfig(DefaultConfig):
     RECAPTCHA_OPTIONS = {"theme": "white"}
 
     # Mail
-    # Google Mail example
-    MAIL_SERVER = "smtp.googlemail.com"
+    # Local SMTP Server
+    #MAIL_SERVER = "localhost"
+    #MAIL_PORT = 25
+    #MAIL_USE_SSL = False
+    #MAIL_USERNAME = ""
+    #MAIL_PASSWORD = ""
+    #MAIL_DEFAULT_SENDER = "noreply@example.org"
+
+    # Google Mail Example
+    MAIL_SERVER = "smtp.gmail.com"
     MAIL_PORT = 465
     MAIL_USE_SSL = True
-    MAIL_USERNAME = "flaskbb@gmail.com"
+    MAIL_USERNAME = "your_username@gmail.com"
     MAIL_PASSWORD = "your_password"
-    MAIL_DEFAULT_SENDER = "flaskbb@gmail.com"
-    # Where to logger should send the emails to
-    ADMINS = ["flaskbb@gmail.com"]
+    MAIL_DEFAULT_SENDER = ("Your Name", "your_username@gmail.com")
+
+    # The user who should recieve the error logs
+    ADMINS = ["your_admin_user@gmail.com"]

flaskbb/configs/production.py.example

@@ -49,6 +49,14 @@ class ProductionConfig(DefaultConfig):
 
 
     ## Mail
+    # Local SMTP Server
+    #MAIL_SERVER = "localhost"
+    #MAIL_PORT = 25
+    #MAIL_USE_SSL = False
+    #MAIL_USERNAME = ""
+    #MAIL_PASSWORD = ""
+    #MAIL_DEFAULT_SENDER = "noreply@example.org"
+
     # Google Mail Example
     MAIL_SERVER = "smtp.gmail.com"
     MAIL_PORT = 465
@@ -56,7 +64,8 @@ class ProductionConfig(DefaultConfig):
     MAIL_USERNAME = "your_username@gmail.com"
     MAIL_PASSWORD = "your_password"
     MAIL_DEFAULT_SENDER = ("Your Name", "your_username@gmail.com")
-    # Where to logger should send the emails to
+
+    # The user who should recieve the error logs
     ADMINS = ["your_admin_user@gmail.com"]
 
 

flaskbb/forum/views.py

@@ -431,7 +431,7 @@ def markread(forum_id=None):
 
 @forum.route("/who_is_online")
 def who_is_online():
-    if current_app.config['USE_REDIS']:
+    if current_app.config['REDIS_ENABLED']:
         online_users = get_online_users()
     else:
         online_users = User.query.filter(User.lastseen >= time_diff()).all()

manage.py

@@ -81,7 +81,7 @@ def createall(dropdb=False, createdb=False):
 @manager.option('-u', '--username', dest='username')
 @manager.option('-p', '--password', dest='password')
 @manager.option('-e', '--email', dest='email')
-def create_admin(username, password, email):
+def create_admin(username=None, password=None, email=None):
     """Creates the admin user"""
 
     if not (username and password and email):
@@ -89,13 +89,13 @@ def create_admin(username, password, email):
         email = prompt("A valid email address")
         password = prompt_pass("Password")
 
-    create_admin_user(username, email, password)
+    create_admin_user(username=username, password=password, email=email)
 
 
 @manager.option('-u', '--username', dest='username')
 @manager.option('-p', '--password', dest='password')
 @manager.option('-e', '--email', dest='email')
-def initflaskbb(username, password, email):
+def initflaskbb(username=None, password=None, email=None):
     """Initializes FlaskBB with all necessary data"""
 
     app.logger.info("Creating default groups...")
@@ -121,9 +121,9 @@ def initflaskbb(username, password, email):
 
     app.logger.info("Creating admin user...")
     if username and password and email:
-        create_admin_user(username, password, email)
+        create_admin_user(username=username, password=password, email=email)
     else:
-        create_admin(username, password, email)
+        create_admin()
 
     app.logger.info("Creating welcome forum...")
     create_welcome_forum()