From 0d58d2441e4481520096a0c1495b4793ad7cb0ff Mon Sep 17 00:00:00 2001 From: Feng Date: Mon, 22 Feb 2016 01:25:59 +0800 Subject: [PATCH] readthedocs --- docs/Makefile | 177 +++++++++++++++++++ docs/make.bat | 242 ++++++++++++++++++++++++++ docs/source/bridge.rst | 48 ++++++ docs/source/cluster.rst | 135 +++++++++++++++ docs/source/commands.rst | 68 ++++++++ docs/source/conf.py | 337 +++++++++++++++++++++++++++++++++++++ docs/source/config.rst | 78 +++++++++ docs/source/getstarted.rst | 186 ++++++++++++++++++++ docs/source/index.rst | 35 ++++ docs/source/install.rst | 135 +++++++++++++++ docs/source/plugins.rst | 47 ++++++ 11 files changed, 1488 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/bridge.rst create mode 100644 docs/source/cluster.rst create mode 100644 docs/source/commands.rst create mode 100644 docs/source/conf.py create mode 100644 docs/source/config.rst create mode 100644 docs/source/getstarted.rst create mode 100644 docs/source/index.rst create mode 100644 docs/source/install.rst create mode 100644 docs/source/plugins.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..167db2e93 --- /dev/null +++ b/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) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.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 ' where 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/ErlangMQTTBroker.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ErlangMQTTBroker.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/ErlangMQTTBroker" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ErlangMQTTBroker" + @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." diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 000000000..f8d18dac5 --- /dev/null +++ b/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% source +set I18NSPHINXOPTS=%SPHINXOPTS% source +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 ^` where ^ 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\ErlangMQTTBroker.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\ErlangMQTTBroker.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 diff --git a/docs/source/bridge.rst b/docs/source/bridge.rst new file mode 100644 index 000000000..8cc1af69f --- /dev/null +++ b/docs/source/bridge.rst @@ -0,0 +1,48 @@ + +.. _bridge:: + + +==================== +Bridge Guide +==================== + + +------------------- +emqttd Node Bridge +------------------- + +:: + --------- --------- --------- + Publisher --> | node1 | --Bridge Forward--> | node2 | --Bridge Forward--> | node3 | --> Subscriber + --------- --------- --------- + + +----------------- +mosquitto Bridge +----------------- + +:: + ------------- ----------------- + Sensor ----> | mosquitto | --Bridge--> | | + ------------- | emqttd | + ------------- | Cluster | + Sensor ----> | mosquitto | --Bridge--> | | + ------------- ----------------- + + +mosquitto.conf +-------------- + + +------------- +rsmb Bridge +------------- + +broker.cfg +---------- + +:: + connection emqttd + addresses 127.0.0.1:2883 + topic sensor/# + diff --git a/docs/source/cluster.rst b/docs/source/cluster.rst new file mode 100644 index 000000000..bc3956fa8 --- /dev/null +++ b/docs/source/cluster.rst @@ -0,0 +1,135 @@ + +.. _cluster: + +==================== +Cluster Guide +==================== + +----------------------------------- +Erlang/OPT Distributed Programming +----------------------------------- + +.. code:: + + --------- --------- + | Node1 | --------| Node2 | + --------- --------- + | \ / | + | \ / | + | / \ | + | / \ | + --------- --------- + | Node3 | --------| Node4 | + --------- --------- + +Node +---------- + +.. code:: shell + + erl -name node1@127.0.0.1 + erl -name node2@127.0.0.1 + erl -name node3@127.0.0.1 + erl -name node4@127.0.0.1 + + + (node1@127.0.0.1)1> net_kernel:connect_node('node2@127.0.0.1'). + true + (node1@127.0.0.1)2> net_kernel:connect_node('node3@127.0.0.1'). + true + (node1@127.0.0.1)3> net_kernel:connect_node('node4@127.0.0.1'). + true + (node1@127.0.0.1)4> nodes(). + ['node2@127.0.0.1','node3@127.0.0.1','node4@127.0.0.1'] + +epmd +---------- + + (node1@127.0.0.1)6> net_adm:names(). + {ok,[{"node1",62740}, + {"node2",62746}, + {"node3",62877}, + {"node4",62895}]} + +Cookie +-------- + + 1. $HOME/.erlang.cookie + + 2. erl -setcookie + +From: http://erlang.org/doc/reference_manual/distributed.html + +---------------------- +Cluster Design +---------------------- + + + topic1 -> node1, node2 + topic2 -> node3 + topic3 -> node2, node4 + + +Topic Trie and Route Table +--------------------------- + +:: + -------------------------- + | t | + | / \ | + | + # | + | / \ | + | x y | + -------------------------- + | t/+/x -> node1, node3 | + | t/+/y -> node1 | + | t/# -> node2 | + | t/a -> node3 | + -------------------------- + + +Subscription and Message Dispatch +--------------------------------- + +:: + title: Message Route and Deliver + + client1->node1: Publish[t/a] + node1-->node2: Route[t/#] + node1-->node3: Route[t/a] + node2-->client2: Deliver[t/#] + node3-->client3: Deliver[t/a] + +.. image:: _static/images/route.png + + +----------------------- +Cluster Configuration +----------------------- + + + +----------------------- +Sessions across Nodes +----------------------- + + + node1 + ----------- + |-->| session | + | ----------- + node2 | + -------------- | + client-->| connection |<--| + -------------- + + +------------------ +Notice: NetSplit +------------------ + + +------------------------ +Consistent Hash and DHT +------------------------ + diff --git a/docs/source/commands.rst b/docs/source/commands.rst new file mode 100644 index 000000000..fe443a8b3 --- /dev/null +++ b/docs/source/commands.rst @@ -0,0 +1,68 @@ + +.. _commands:: + +=================== +Admin Command Line +=================== + + +---------- +status +---------- + +---------- +broker +---------- + +----------- +cluster +----------- + +----------- +clients +----------- + + +----------- +sessions +----------- + + +----------- +topics +----------- + + +----------------- +subscriptions +----------------- + + +----------- +plugins +----------- + + +---------- +bridges +---------- + +------ +vm +------ + + +--------- +trace +--------- + + +---------- +listeners +---------- + +---------- +mnesia +---------- + + diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 000000000..f96ed0579 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,337 @@ +# -*- coding: utf-8 -*- +# +# Erlang MQTT Broker documentation build configuration file, created by +# sphinx-quickstart on Mon Feb 22 00:46:47 2016. +# +# 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('.')) + +# -- 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', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', +] + +# 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'Erlang MQTT Broker' +copyright = u'2016, Feng Lee' + +# 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 = '1.0' +# The full version, including alpha/beta/rc tags. +release = '1.0' + +# 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 = [] + +# 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 = 'default' + +# 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 = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v 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 = {} + +# 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 = True + +# 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 = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a 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 = 'ErlangMQTTBrokerdoc' + + +# -- 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', 'ErlangMQTTBroker.tex', u'Erlang MQTT Broker Documentation', + u'Feng Lee', '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', 'erlangmqttbroker', u'Erlang MQTT Broker Documentation', + [u'Feng Lee'], 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', 'ErlangMQTTBroker', u'Erlang MQTT Broker Documentation', + u'Feng Lee', 'ErlangMQTTBroker', '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 + + +# -- Options for Epub output ---------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'Erlang MQTT Broker' +epub_author = u'Feng Lee' +epub_publisher = u'Feng Lee' +epub_copyright = u'2016, Feng Lee' + +# The basename for the epub file. It defaults to the project name. +#epub_basename = u'Erlang MQTT Broker' + +# The HTML theme for the epub output. Since the default themes are not optimized +# for small screen space, using the same theme for HTML and epub output is +# usually not wise. This defaults to 'epub', a theme designed to save visual +# space. +#epub_theme = 'epub' + +# The language of the text. It defaults to the language option +# or en if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +#epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +#epub_identifier = '' + +# A unique identification for the text. +#epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +#epub_cover = () + +# A sequence of (type, uri, title) tuples for the guide element of content.opf. +#epub_guide = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True + +# Choose between 'default' and 'includehidden'. +#epub_tocscope = 'default' + +# Fix unsupported image types using the PIL. +#epub_fix_images = False + +# Scale large images. +#epub_max_image_width = 0 + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#epub_show_urls = 'inline' + +# If false, no index is generated. +#epub_use_index = True + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/docs/source/config.rst b/docs/source/config.rst new file mode 100644 index 000000000..5ac233112 --- /dev/null +++ b/docs/source/config.rst @@ -0,0 +1,78 @@ + +.. _configuration: + +====================== +Configuration +====================== + + +------------ +etc/vm.args +------------ + +.. code:: + + ##------------------------------------------------------------------------- + ## Name of the node + ##------------------------------------------------------------------------- + -name emqttd@127.0.0.1 + + ## Cookie for distributed erlang + -setcookie emqttdsecretcookie + + ##------------------------------------------------------------------------- + ## Flags + ##------------------------------------------------------------------------- + + ## Heartbeat management; auto-restarts VM if it dies or becomes unresponsive + ## (Disabled by default..use with caution!) + ##-heart + -smp true + + ## Enable kernel poll and a few async threads + +K true + + ## 12 threads/core. + +A 48 + + ## max process numbers + +P 8192 + + ## Sets the maximum number of simultaneously existing ports for this system + +Q 8192 + + ## max atom number + ## +t + + ## Set the distribution buffer busy limit (dist_buf_busy_limit) in kilobytes. + ## Valid range is 1-2097151. Default is 1024. + ## +zdbbl 8192 + + ## CPU Schedulers + ## +sbt db + + ##------------------------------------------------------------------------- + ## Env + ##------------------------------------------------------------------------- + + ## Increase number of concurrent ports/sockets, deprecated in R17 + -env ERL_MAX_PORTS 8192 + + -env ERTS_MAX_PORTS 8192 + + -env ERL_MAX_ETS_TABLES 1024 + + ## Tweak GC to run more often + -env ERL_FULLSWEEP_AFTER 1000 + +------------------ +etc/emqttd.config +------------------ + + +Log Level +------------- + +Broker Parameters +------------------ + diff --git a/docs/source/getstarted.rst b/docs/source/getstarted.rst new file mode 100644 index 000000000..4be93787c --- /dev/null +++ b/docs/source/getstarted.rst @@ -0,0 +1,186 @@ + +.. _getstarted: + +============ +Get Started +============ + +-------------------- +Overview +-------------------- + + +-------------------- +MQTT PubSub +-------------------- + +-------------------------- +Quick Start +-------------------------- + +.. code:: console + + unzip emqttd-macosx-0.16.0-beta-20160216.zip && cd emqttd + + # Start emqttd + ./bin/emqttd start + + # Check Status + ./bin/emqttd_ctl status + + # Stop emqttd + ./bin/emqttd stop + +-------------------- +Compile from Source +-------------------- + +.. code:: console + + git clone https://github.com/emqtt/emqttd.git + + cd emqttd && make && make dist + +-------------------- +Web Dashboard +-------------------- + +.. image:: ./_static/images/dashboard.png + + +-------------------- +Features List +-------------------- + +* Full MQTT V3.1/V3.1.1 protocol specification support +* QoS0, QoS1, QoS2 Publish and Subscribe +* Session Management and Offline Messages +* Retained Messages Support +* Last Will Message Support +* TCP/SSL Connection Support +* MQTT Over Websocket(SSL) Support +* HTTP Publish API Support +* [$SYS/brokers/#](https://github.com/emqtt/emqtt/wiki/$SYS-Topics-of-Broker) Support +* Client Authentication with clientId, ipaddress +* Client Authentication with username, password. +* Client ACL control with ipaddress, clientid, username. +* Cluster brokers on several servers. +* [Bridge](https://github.com/emqtt/emqttd/wiki/Bridge) brokers locally or remotely +* 500K+ concurrent clients connections per server +* Extensible architecture with Hooks, Modules and Plugins +* Passed eclipse paho interoperability tests + +-------------------- +Modules and Plugins +-------------------- + +Modules +-------- + +* [emqttd_auth_clientid](https://github.com/emqtt/emqttd/wiki/Authentication) - Authentication with ClientIds +* [emqttd_auth_username](https://github.com/emqtt/emqttd/wiki/Authentication) - Authentication with Username and Password +* [emqttd_auth_ldap](https://github.com/emqtt/emqttd/wiki/Authentication) - Authentication with LDAP +* [emqttd_mod_presence](https://github.com/emqtt/emqttd/wiki/Presence) - Publish presence message to $SYS topics when client connected or disconnected +* emqttd_mod_autosub - Subscribe topics when client connected +* [emqttd_mod_rewrite](https://github.com/emqtt/emqttd/wiki/Rewrite) - Topics rewrite like HTTP rewrite module + +Plugins +-------- + +* [emqttd_plugin_template](https://github.com/emqtt/emqttd_plugin_template) - Plugin template and demo +* [emqttd_dashboard](https://github.com/emqtt/emqttd_dashboard) - Web Dashboard +* [emqttd_plugin_mysql](https://github.com/emqtt/emqttd_plugin_mysql) - Authentication with MySQL +* [emqttd_plugin_pgsql](https://github.com/emqtt/emqttd_plugin_pgsql) - Authentication with PostgreSQL +* [emqttd_plugin_kafka](https://github.com/emqtt/emqtt_kafka) - Publish MQTT Messages to Kafka +* [emqttd_plugin_redis](https://github.com/emqtt/emqttd_plugin_redis) - Redis Plugin +* [emqttd_plugin_mongo](https://github.com/emqtt/emqttd_plugin_mongo) - MongoDB Plugin +* [emqttd_stomp](https://github.com/emqtt/emqttd_stomp) - Stomp Protocol Plugin +* [emqttd_sockjs](https://github.com/emqtt/emqttd_sockjs) - SockJS(Stomp) Plugin +* [emqttd_recon](https://github.com/emqtt/emqttd_recon) - Recon Plugin + +---------------------------------- +One million Connections Benchmark +---------------------------------- + +Linux Kernel Parameters +----------------------- + +.. code:: + + sysctl -w fs.file-max=2097152 + sysctl -w fs.nr_open=2097152 + +TCP Stack Parameters +----------------------- + +.. code:: + + sysctl -w net.core.somaxconn=65536 + +Erlang VM +----------------- + +emqttd/etc/vm.args:: + + ## max process numbers + +P 2097152 + + ## Sets the maximum number of simultaneously existing ports for this system + +Q 1048576 + + ## Increase number of concurrent ports/sockets + -env ERL_MAX_PORTS 1048576 + + -env ERTS_MAX_PORTS 1048576 + +emqttd.config +----------------- + +emqttd/etc/emqttd.config:: + + {mqtt, 1883, [ + %% Size of acceptor pool + {acceptors, 64}, + + %% Maximum number of concurrent clients + {max_clients, 1000000}, + + %% Socket Access Control + {access, [{allow, all}]}, + + %% Connection Options + {connopts, [ + %% Rate Limit. Format is 'burst, rate', Unit is KB/Sec + %% {rate_limit, "100,10"} %% 100K burst, 10K rate + ]}, + ... + +Test Client +----------- + +.. code:: + + sysctl -w net.ipv4.ip_local_port_range="500 65535" + echo 1000000 > /proc/sys/fs/nr_open + +---------------------------- +emqtt MQTT Client Libraries +---------------------------- + +GitHub: https://github.com/emqtt + ++--------------------+----------------------+ +| `emqttc`_ | Erlang MQTT Client | ++--------------------+----------------------+ +| `emqtt_benchmark`_ | MQTT benchmark Tool | ++--------------------+----------------------+ +| `CocoaMQTT`_ | Swift MQTT Client | ++--------------------+----------------------+ +| `QMQTT`_ | QT MQTT Client | ++--------------------+----------------------+ + +.. _emqttc: https://github.com/emqtt/emqttc +.. _emqtt_benchmark: https://github.com/emqtt/emqtt_benchmark +.. _CocoaMQTT: https://github.com/emqtt/CocoaMQTT +.. _QMQTT: https://github.com/emqtt/qmqtt + diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 000000000..72d41c8e7 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,35 @@ +.. Erlang MQTT Broker documentation master file, created by + sphinx-quickstart on Mon Feb 22 00:46:47 2016. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Erlang MQTT Broker's documentation! +============================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + getstarted + install + config + cluster + bridge + commands + plugins + +Support and Contacts: + ++------------+--------------------------------+ +| Site: | http://emqtt.io | ++------------+--------------------------------+ +| GitHub: | https://github.com/emqtt | ++------------+--------------------------------+ +| Twitter: | @emqtt | ++------------+--------------------------------+ +| Author: | Feng Lee | ++------------+--------------------------------+ + + + diff --git a/docs/source/install.rst b/docs/source/install.rst new file mode 100644 index 000000000..4ba42200f --- /dev/null +++ b/docs/source/install.rst @@ -0,0 +1,135 @@ + +======================= +Installation +======================= + + +.. NOTE:: + + Linux, FreeBSD Recommended. + +---------------- +Download +---------------- + +Download binary package from: http://emqtt.io/downloads + ++-----------+-----------------------------------+ +| Ubuntu | http://emqtt.io/downloads/ubuntu | ++-----------+-----------------------------------+ +| CentOS | http://emqtt.io/downloads/centos | ++-----------+-----------------------------------+ +| FreeBSD | http://emqtt.io/downloads/freebsd | ++-----------+-----------------------------------+ +| Mac OS X | http://emqtt.io/downloads/macosx | ++-----------+-----------------------------------+ +| Windows | http://emqtt.io/downloads/windows | ++-----------+-----------------------------------+ + + +-------------------- +Installing on Linux +-------------------- + +CentOS: http://emqtt.io/downloads/centos + +.. code:: console + + unzip emqttd-centos64-0.16.0-beta-20160216.zip + + + +.. code:: console + + cd emqttd && ./bin/emqttd console + + +.. code:: console + + starting emqttd on node 'emqttd@127.0.0.1' + emqttd ctl is starting...[done] + emqttd trace is starting...[done] + emqttd pubsub is starting...[done] + emqttd stats is starting...[done] + emqttd metrics is starting...[done] + emqttd retainer is starting...[done] + emqttd pooler is starting...[done] + emqttd client manager is starting...[done] + emqttd session manager is starting...[done] + emqttd session supervisor is starting...[done] + emqttd broker is starting...[done] + emqttd alarm is starting...[done] + emqttd mod supervisor is starting...[done] + emqttd bridge supervisor is starting...[done] + emqttd access control is starting...[done] + emqttd system monitor is starting...[done] + http listen on 0.0.0.0:18083 with 4 acceptors. + mqtt listen on 0.0.0.0:1883 with 16 acceptors. + mqtts listen on 0.0.0.0:8883 with 4 acceptors. + http listen on 0.0.0.0:8083 with 4 acceptors. + Erlang MQTT Broker 0.16.0 is running now + Eshell V6.4 (abort with ^G) + (emqttd@127.0.0.1)1> + + +.. code:: console + + ./bin/emqttd start + + +.. code:: console + + ./bin/emqttd_ctl status + + +.. code:: console + + $ ./bin/emqttd_ctl status + Node 'emqttd@127.0.0.1' is started + emqttd 0.16.0 is running + + + http://localhost:8083/status + + + ./bin/emqttd stop + +--------------------- +Installing on FreeBSD +--------------------- + +FreeBSD: http://emqtt.io/downloads/freebsd + +----------------------- +Installing on Mac +----------------------- + +.. code:: erlang + +----------------------- +Installing on Windows +----------------------- + +----------------------- +Installing From Source +----------------------- + +.. code:: console + + git clone https://github.com/emqtt/emqttd.git + + cd emqttd + + make && make dist + +Binary Package:: + + rel/emqttd + +------------------- +/etc/init.d/emqttd +------------------- + + + + diff --git a/docs/source/plugins.rst b/docs/source/plugins.rst new file mode 100644 index 000000000..f5bba4374 --- /dev/null +++ b/docs/source/plugins.rst @@ -0,0 +1,47 @@ + +.. _plugins: + +================= +Plugins +================= + +------------------------------------ +emqttd_plugin_template +------------------------------------ + +----------------------------------- +emqttd_dashboard: Dashboard Plugin +----------------------------------- + +Configure Dashboard +-------------------- + +------------------------------------------- +emqttd_plugin_mysql: +------------------------------------------- + +------------------------------------------------ +emqttd_plugin_pgsql: +------------------------------------------------ + +-------------------------------------------- +emqttd_plugin_redis: +-------------------------------------------- + +----------------------------- +emqttd_stomp: +----------------------------- + +-------------------------------- +emqttd_sockjs: +-------------------------------- + +-------------------------------- +emqttd_recon: Recon Plugin +-------------------------------- + +------------------------- +Plugin Development Guide +------------------------- + +