diff --git a/docs/Catalogs b/docs/Catalogs deleted file mode 100644 index 9e5278125..000000000 --- a/docs/Catalogs +++ /dev/null @@ -1,36 +0,0 @@ -ReadMe - Overview - C1000K - Goals - Features - Plugins - Supports - Twitter -QuickStart - -Getting Started - Overview - Goals - Features - Plugins - Supports - Twitter - FAQ - -UserGuide - Installation - Configuration - Administration - Cluster - -PluginGuide - - Plugin Guide - Plugins - -DesignGuide - Architecture - -TuningGuide - - diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 167db2e93..000000000 --- a/docs/Makefile +++ /dev/null @@ -1,177 +0,0 @@ -# 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/README.md b/docs/README.md deleted file mode 100644 index 5b6f5fe93..000000000 --- a/docs/README.md +++ /dev/null @@ -1,3 +0,0 @@ - -Documents for eMQTT Projects - diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index f8d18dac5..000000000 --- a/docs/make.bat +++ /dev/null @@ -1,242 +0,0 @@ -@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/_images/Architecture.png b/docs/source/_images/Architecture.png deleted file mode 100644 index 77c7dcc9e..000000000 Binary files a/docs/source/_images/Architecture.png and /dev/null differ diff --git a/docs/source/_images/Design_Cluster.png b/docs/source/_images/Design_Cluster.png deleted file mode 100644 index 77c7dcc9e..000000000 Binary files a/docs/source/_images/Design_Cluster.png and /dev/null differ diff --git a/docs/source/_images/Design_Standalone.png b/docs/source/_images/Design_Standalone.png deleted file mode 100644 index 992694523..000000000 Binary files a/docs/source/_images/Design_Standalone.png and /dev/null differ diff --git a/docs/source/_images/PersistentSessionSeq1.png b/docs/source/_images/PersistentSessionSeq1.png deleted file mode 100644 index 07e3b9856..000000000 Binary files a/docs/source/_images/PersistentSessionSeq1.png and /dev/null differ diff --git a/docs/source/_images/PersistentSessionSeq2.png b/docs/source/_images/PersistentSessionSeq2.png deleted file mode 100644 index 5a731c230..000000000 Binary files a/docs/source/_images/PersistentSessionSeq2.png and /dev/null differ diff --git a/docs/source/_images/PubSub_CleanSess_0.png b/docs/source/_images/PubSub_CleanSess_0.png deleted file mode 100644 index 831d25f8a..000000000 Binary files a/docs/source/_images/PubSub_CleanSess_0.png and /dev/null differ diff --git a/docs/source/_images/PubSub_CleanSess_1.png b/docs/source/_images/PubSub_CleanSess_1.png deleted file mode 100644 index bd6227e3a..000000000 Binary files a/docs/source/_images/PubSub_CleanSess_1.png and /dev/null differ diff --git a/docs/source/_images/Seq.png b/docs/source/_images/Seq.png deleted file mode 100644 index b77f682a1..000000000 Binary files a/docs/source/_images/Seq.png and /dev/null differ diff --git a/docs/source/_images/TransientSessionSeq1.png b/docs/source/_images/TransientSessionSeq1.png deleted file mode 100644 index c15e24435..000000000 Binary files a/docs/source/_images/TransientSessionSeq1.png and /dev/null differ diff --git a/docs/source/_images/TransientSessionSeq2.png b/docs/source/_images/TransientSessionSeq2.png deleted file mode 100644 index 210b9e526..000000000 Binary files a/docs/source/_images/TransientSessionSeq2.png and /dev/null differ diff --git a/docs/source/_images/emqttd.graphml b/docs/source/_images/emqttd.graphml deleted file mode 100644 index 0add31baf..000000000 --- a/docs/source/_images/emqttd.graphml +++ /dev/null @@ -1,993 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - emqttd broker cluster - - - - - - - - - - Folder 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - x - - - - - - - - - - - - - - - - - y - - - - - - - - - - - - - - - - - t - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - x - - - - - - - - - - - - - - - - - y - - - - - - - - - - - - - - - - - t - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - x - - - - - - - - - - - - - - - - - y - - - - - - - - - - - - - - - - - t - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - x - - - - - - - - - - - - - - - - - y - - - - - - - - - - - - - - - - - t - - - - - - - - - - - - - - - - - - - Client - - - - - - - - - - - - - - - - - Sensor - - - - - - - - - - - - - - - - - Sensor - - - - - - - - - - - - - - - - - Client - - - - - - - - - - - - - - - - - - Application Server - - - - - - - - - - - - - - - - - - Web - - - - - - - - - - - - - - - - - - Web - - - - - - - - - - - - - - - - - - iPhone - - - - - - - - - - - - - - - - - - Android - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - MQTT - - - - - - - - - - - - - - - - - - - HTTP - - - - - - - - - - - - - - - - - - - MQTT - - - - - - - - - - - - - - - - - - - WebSocket - - - - - - - - - - - - - - - - - - - WebSocket - - - - - - - - - - - - - - - - - - - MQTT - - - - - - - - - - - - - - - - - - - MQTT - - - - - - - - - - - - - - - - - - - MQTT - - - - - - - - - - - - - - - - diff --git a/docs/source/_images/emqttd.png b/docs/source/_images/emqttd.png deleted file mode 100644 index 6066d5d08..000000000 Binary files a/docs/source/_images/emqttd.png and /dev/null differ diff --git a/docs/source/_images/emqttd2.png b/docs/source/_images/emqttd2.png deleted file mode 100644 index 6066d5d08..000000000 Binary files a/docs/source/_images/emqttd2.png and /dev/null differ diff --git a/docs/source/_images/qos0_seq.png b/docs/source/_images/qos0_seq.png deleted file mode 100644 index a1ca32c0d..000000000 Binary files a/docs/source/_images/qos0_seq.png and /dev/null differ diff --git a/docs/source/_static/.placeholder b/docs/source/_static/.placeholder deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/source/_templates/.placeholder b/docs/source/_templates/.placeholder deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/source/apps/chat.rst b/docs/source/apps/chat.rst deleted file mode 100644 index 26406aa30..000000000 --- a/docs/source/apps/chat.rst +++ /dev/null @@ -1,2 +0,0 @@ -Chat -==== diff --git a/docs/source/apps/index.rst b/docs/source/apps/index.rst deleted file mode 100644 index aebdbc89a..000000000 --- a/docs/source/apps/index.rst +++ /dev/null @@ -1,10 +0,0 @@ - -Applications -============ - -.. toctree:: - :maxdepth: 2 - - push - chat - diff --git a/docs/source/apps/push.rst b/docs/source/apps/push.rst deleted file mode 100644 index ea233dcd4..000000000 --- a/docs/source/apps/push.rst +++ /dev/null @@ -1,2 +0,0 @@ -Push -==== diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index 6b33ad3f6..000000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,342 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Erlang MQTT Broker documentation build configuration file, created by -# sphinx-quickstart on Tue Jan 12 22:54:45 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 -from recommonmark.parser import CommonMarkParser - -# 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.doctest', - 'sphinx.ext.intersphinx', - 'sphinx.ext.todo', - 'sphinx.ext.coverage', - 'sphinx.ext.ifconfig', -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -source_parsers = {'.md': CommonMarkParser} - -# 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 = '0.15' -# The full version, including alpha/beta/rc tags. -release = '0.15.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/design/ClientSession.md b/docs/source/design/ClientSession.md deleted file mode 100644 index c7f6f53d2..000000000 --- a/docs/source/design/ClientSession.md +++ /dev/null @@ -1,55 +0,0 @@ -## Transient Client/Session Sequence1 - -``` -Client1->SM: {start_session, {true, ClientId, self()}} -SM-->Session: {destory, ClientId} -Session-->Session: {shutdown, destroy} -Session-->Client2: exit({shutdown, destroy}) -Client2-->CM: {'DOWN', MRef, process, Pid, Reason} -SM-->Client1: {ok, SessPid} -Client1-->CM: {register, Client1} -``` - -![Transient Client/Session Sequence1](TransientSessionSeq1.png) - -## Transient Client/Session Sequence2 - - -``` -Client1->SM: {start_session, {true, ClientId, self()}} -SM-->Session: {destory, ClientId} -Session-->Session: {shutdown, destroy} -SM-->Client1: {ok, SessPid} -Client1-->CM: {register, Client1} -Session-->Client2: exit({shutdown, destroy}) -Client2-->CM: {'DOWN', MRef, process, Pid, Reason} -``` - -![Transient Client/Session Sequence2](TransientSessionSeq2.png) - -## Persistent Client/Session Sequence1 - -``` -Client1->SM: {start_session, {true, ClientId, self()}} -SM-->Session: {resume, ClientId, ClientPid} -Session-->Client2: {shutdown, conflict, {ClientId, Pid}} -Client2-->CM: {unregister, ClientId, self()} -SM-->Client1: {ok, SessPid} -Client1-->CM: {register, Client1} -``` - -![Persistent Client/Session Sequence1](PersistentSessionSeq1.png) - - -## Persistent Client/Session Sequence2 - -``` -Client1->SM: {start_session, {true, ClientId, self()}} -SM-->Session: {resume, ClientId, ClientPid} -SM-->Client1: {ok, SessPid} -Client1-->CM: {register, Client1} -Session-->Client2: {shutdown, conflict, {ClientId, Pid}} -Client2-->CM: {unregister, ClientId, self()} -``` - -![Persistent Client/Session Sequence2](PersistentSessionSeq2.png) diff --git a/docs/source/design/Design_Cluster.graphml b/docs/source/design/Design_Cluster.graphml deleted file mode 100644 index 0e1e06791..000000000 --- a/docs/source/design/Design_Cluster.graphml +++ /dev/null @@ -1,847 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - emqttd cluster - - - - - - - - - - Folder 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - x - - - - - - - - - - - - - - - - - - y - - - - - - - - - - - - - - - - - - t - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - x - - - - - - - - - - - - - - - - - - y - - - - - - - - - - - - - - - - - - t - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - x - - - - - - - - - - - - - - - - - - y - - - - - - - - - - - - - - - - - - t - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - x - - - - - - - - - - - - - - - - - - y - - - - - - - - - - - - - - - - - - t - - - - - - - - - - - - - - - - - - - - P - - - - - - - - - - - - - - - - - - P - - - - - - - - - - - - - - - - - - S - - - - - - - - - - - - - - - - - - S - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/source/design/Design_Standalone.graphml b/docs/source/design/Design_Standalone.graphml deleted file mode 100644 index 9382a66f6..000000000 --- a/docs/source/design/Design_Standalone.graphml +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - P - - - - - - - - - - - - - - - - - - P - - - - - - - - - - - - - - - - - - S - - - - - - - - - - - - - - - - - - S - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - x - - - - - - - - - - - - - - - - - - y - - - - - - - - - - - - - - - - - - t - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/source/design/architecture.rst b/docs/source/design/architecture.rst deleted file mode 100644 index c598bc089..000000000 --- a/docs/source/design/architecture.rst +++ /dev/null @@ -1,14 +0,0 @@ - -Architecture -=========== - -Philosophy ----------- - -Focuse on scalable, stable transport and router. - -Control plane and Flow plane. - -Multiple Backends - - diff --git a/docs/source/design/clustering.rst b/docs/source/design/clustering.rst deleted file mode 100644 index 29dc38063..000000000 --- a/docs/source/design/clustering.rst +++ /dev/null @@ -1,5 +0,0 @@ - -Clustering -========== - - diff --git a/docs/source/design/guid.rst b/docs/source/design/guid.rst deleted file mode 100644 index 6ea98599e..000000000 --- a/docs/source/design/guid.rst +++ /dev/null @@ -1,21 +0,0 @@ -GUID -==== - -Each QoS1/2 MQTT message is identified by a 128 bits, k-ordered GUID(global unique ID). - -Structure ---------- - -:: - - -------------------------------------------------------- - | Timestamp | NodeID + PID | Sequence | - |<------- 64bits ------->|<--- 48bits --->|<- 16bits ->| - -------------------------------------------------------- - - -1. Timestamp: erlang:system_time if Erlang >= R18, otherwise os:timestamp -2. NodeId: encode node() to 2 bytes integer -3. Pid: encode pid to 4 bytes integer -4. Sequence: 2 bytes sequence in one process - diff --git a/docs/source/design/index.rst b/docs/source/design/index.rst deleted file mode 100644 index 1e13faf2f..000000000 --- a/docs/source/design/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -Design Guide ------------- - -.. toctree:: - - architecture - clustering - pubsub - route - qos - pool - guid - metrics - stats - diff --git a/docs/source/design/metrics.rst b/docs/source/design/metrics.rst deleted file mode 100644 index bc99d8a92..000000000 --- a/docs/source/design/metrics.rst +++ /dev/null @@ -1,3 +0,0 @@ - -Metrics -======= diff --git a/docs/source/design/pool.rst b/docs/source/design/pool.rst deleted file mode 100644 index 6aec842e5..000000000 --- a/docs/source/design/pool.rst +++ /dev/null @@ -1,3 +0,0 @@ -Pool -==== - diff --git a/docs/source/design/pubsub.rst b/docs/source/design/pubsub.rst deleted file mode 100644 index 17a457e48..000000000 --- a/docs/source/design/pubsub.rst +++ /dev/null @@ -1,3 +0,0 @@ - -PubSub -====== diff --git a/docs/source/design/qos.rst b/docs/source/design/qos.rst deleted file mode 100644 index fd464a39e..000000000 --- a/docs/source/design/qos.rst +++ /dev/null @@ -1,13 +0,0 @@ - -QoS -=== - -PacketId - -MessageId - -QoS0 - -QoS1 - -QoS2 diff --git a/docs/source/design/route.rst b/docs/source/design/route.rst deleted file mode 100644 index 89882c23f..000000000 --- a/docs/source/design/route.rst +++ /dev/null @@ -1,11 +0,0 @@ - -Route -===== - -Topic Trie - -Topic -> Node1, Node2, Node3, ... - -Topic -> Pid1, Pid2, Pid3, ... - - diff --git a/docs/source/design/stats.rst b/docs/source/design/stats.rst deleted file mode 100644 index cfb71538e..000000000 --- a/docs/source/design/stats.rst +++ /dev/null @@ -1,3 +0,0 @@ -Statistics -========== - diff --git a/docs/source/dev/backends.rst b/docs/source/dev/backends.rst deleted file mode 100644 index 15e1a2714..000000000 --- a/docs/source/dev/backends.rst +++ /dev/null @@ -1,2 +0,0 @@ -Backends -======== diff --git a/docs/source/dev/hooks.rst b/docs/source/dev/hooks.rst deleted file mode 100644 index 6f44e080d..000000000 --- a/docs/source/dev/hooks.rst +++ /dev/null @@ -1,2 +0,0 @@ -Hooks -===== diff --git a/docs/source/dev/index.rst b/docs/source/dev/index.rst deleted file mode 100644 index 170fec493..000000000 --- a/docs/source/dev/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -Developer Guide ---------------- - -.. toctree:: - - modules - hooks - plugins - diff --git a/docs/source/dev/modules.rst b/docs/source/dev/modules.rst deleted file mode 100644 index 79e62b93d..000000000 --- a/docs/source/dev/modules.rst +++ /dev/null @@ -1,2 +0,0 @@ -Modules -======= diff --git a/docs/source/dev/plugins.rst b/docs/source/dev/plugins.rst deleted file mode 100644 index 936b796fc..000000000 --- a/docs/source/dev/plugins.rst +++ /dev/null @@ -1,5 +0,0 @@ - -Plugins -======= - - diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index a409cb3c5..000000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,78 +0,0 @@ -.. Erlang MQTT Broker documentation master file, created by - sphinx-quickstart on Tue Jan 12 22:54:45 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! -============================================== - -Overview --------- - -TODO: emqttd is a massively scalable and clusterable MQTT V3.1/V3.1.1 broker written in Erlang/OTP. emqttd support both MQTT V3.1/V3.1.1 protocol specification with extended features. - -Features --------- - -* Feature1 -* Feature2 - -QuickStart ----------- - -``hahal`` - -Contents --------- - -.. _get-started: - -.. toctree:: - :maxdepth: 2 - :caption: Getting Started - - intro/overview - intro/quick_started - intro/getting_started - -.. _user-guide: - -.. toctree:: - :maxdepth: 2 - - user/index - -.. _dev-guide: - -.. toctree:: - :maxdepth: 2 - - dev/index - -.. _tune-guide: - -.. toctree:: - :maxdepth: 2 - - tune/index - -.. _design-guide: - -.. toctree:: - :maxdepth: 2 - - design/index - -.. _apps-guide: - -.. toctree:: - :maxdepth: 2 - - apps/index - -Supports ----------- - -* Feature1 -* Feature2 - diff --git a/docs/source/intro/features.rst b/docs/source/intro/features.rst deleted file mode 100644 index 4ef05a8ad..000000000 --- a/docs/source/intro/features.rst +++ /dev/null @@ -1,21 +0,0 @@ -Featrues -======== - -* 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 brokers locally or remotely -* 500K+ concurrent clients connections per server -* Extensible architecture with plugin support -* Passed eclipse paho interoperability tests - diff --git a/docs/source/intro/getting_started.rst b/docs/source/intro/getting_started.rst deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/source/intro/index.rst b/docs/source/intro/index.rst deleted file mode 100644 index 77ab23a73..000000000 --- a/docs/source/intro/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -Getting Started ---------------- - - -.. toctree:: - - overview - features - diff --git a/docs/source/intro/overview.rst b/docs/source/intro/overview.rst deleted file mode 100644 index 9bbec556d..000000000 --- a/docs/source/intro/overview.rst +++ /dev/null @@ -1,28 +0,0 @@ -Overview -======== - -emqttd is a massively scalable and clusterable MQTT V3.1/V3.1.1 broker written in Erlang/OTP. emqttd support both MQTT V3.1/V3.1.1 protocol specification with extended features. - -emqttd could connect Sensor, Mobile, Web Browser and Application Server with asynchronous PUB/SUB messsages. - -.. image:: ../_images/emqttd.png - - -Philosophy ----------- - -Focuse on scalable connection layer and message router layer. - - -Goals ------ - -TODO:... - -emqttd is aimed to provide a solid, enterprise grade, extensible open-source MQTT broker for IoT(M2M) applications that need to support ten millions of concurrent MQTT clients. - -* Easy to install -* Massively scalable -* Easy to extend -* Solid stable - diff --git a/docs/source/intro/quick_start.rst b/docs/source/intro/quick_start.rst deleted file mode 100644 index 2005251e8..000000000 --- a/docs/source/intro/quick_start.rst +++ /dev/null @@ -1,30 +0,0 @@ - -Download and Install -===================== - -Download binary packeges for linux, mac and freebsd from http://emqtt.io/downloads - -:: - - tar xvf emqttd-ubuntu64-0.7.0-alpha.tgz && cd emqttd - - # start console - ./bin/emqttd console - - # start as daemon - ./bin/emqttd start - - # check status - ./bin/emqttd_ctl status - - # stop - ./bin/emqttd stop - -Build from Source -================== - -:: - - git clone https://github.com/emqtt/emqttd.git - - cd emqttd && make && make dist diff --git a/docs/source/mqtt/MQTT_V3.1_Protocol_Specific.pdf b/docs/source/mqtt/MQTT_V3.1_Protocol_Specific.pdf deleted file mode 100644 index 2ea1b2cab..000000000 Binary files a/docs/source/mqtt/MQTT_V3.1_Protocol_Specific.pdf and /dev/null differ diff --git a/docs/source/mqtt/index.rst b/docs/source/mqtt/index.rst deleted file mode 100644 index 380cb9dba..000000000 --- a/docs/source/mqtt/index.rst +++ /dev/null @@ -1,5 +0,0 @@ - -.. toctree:: - - intro - diff --git a/docs/source/mqtt/intro.rst b/docs/source/mqtt/intro.rst deleted file mode 100644 index b5b236c0b..000000000 --- a/docs/source/mqtt/intro.rst +++ /dev/null @@ -1,2 +0,0 @@ -MQTT Introduce -============== diff --git a/docs/source/mqtt/mqtt-v3.1.1-os.pdf b/docs/source/mqtt/mqtt-v3.1.1-os.pdf deleted file mode 100644 index 03a935fdd..000000000 Binary files a/docs/source/mqtt/mqtt-v3.1.1-os.pdf and /dev/null differ diff --git a/docs/source/mqtt/rfc6455.pdf b/docs/source/mqtt/rfc6455.pdf deleted file mode 100644 index 74625160e..000000000 Binary files a/docs/source/mqtt/rfc6455.pdf and /dev/null differ diff --git a/docs/source/tune/benchmark_0.13.0.rst b/docs/source/tune/benchmark_0.13.0.rst deleted file mode 100644 index 64194f3b7..000000000 --- a/docs/source/tune/benchmark_0.13.0.rst +++ /dev/null @@ -1,167 +0,0 @@ -0.13.0 Benchmark (2015-11-08) -============================= - -Benchmark with the [emqtt_benchmark](https://github.com/emqtt/emqtt_benchmark) tool. - -Server: 8 Core, 32G Memory CentOS6. - -etc/vm.args ------------ - -:: - - ## max process numbers - +P 1000000 - - ## Sets the maximum number of simultaneously existing ports for this system - +Q 409600 - - ## 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 - - ##------------------------------------------------------------------------- - ## Env - ##------------------------------------------------------------------------- - - ## Increase number of concurrent ports/sockets, deprecated in R17 - -env ERL_MAX_PORTS 409600 - - -env ERTS_MAX_PORTS 409600 - - -250K Subscribers on five nodes ------------------------------- - -Create 50K connections on each node and subscribe test/%i topics:: - - ./emqtt_bench_sub -h server -p 1883 -c 50000 -i 5 -t test/%i -q 1 - - -Publish 4K msg/sec on server ------------------------------- - -Publish qos1 messages at the rate of 4K(msg/sec) on the server:: - - ./emqtt_bench_pub -h localhost -c 40 -i 10 -I 10 -t test/%i -q 1 - -Each node will receive 4k msg/sec. - - -Benchmark Result ----------------- - -250K Connections, -50K Topics, -250K Subscribers, -4K Qos1 Messages/Sec In, -20K Qos1 Messages/Sec Out, -12M+(bps) In, 56M+(bps) Out Traffic - -Consumed about 3.1G memory and 400+ CPU. - - -./bin/emqttd_ctl broker ------------------------ - - -sysdescr : Erlang MQTT Broker -version : 0.13.0 -uptime : 20 minutes, 25 seconds -datetime : 2015-11-08 10:38:30 - -./bin/emqttd_ctl broker stats ------------------------ - -``` -clients/count : 250040 -clients/max : 250040 -queues/count : 0 -queues/max : 0 -retained/count : 2 -retained/max : 2 -sessions/count : 0 -sessions/max : 0 -subscribers/count : 250000 -subscribers/max : 250000 -topics/count : 50050 -topics/max : 50050 -``` - -./bin/emqttd_ctl listeners ------------------------ - -``` -listener on http:8083 -acceptors : 4 -max_clients : 64 -current_clients : 0 -shutdown_count : [] -listener on mqtts:8883 -acceptors : 4 -max_clients : 512 -current_clients : 0 -shutdown_count : [] -listener on mqtt:1883 -acceptors : 64 -max_clients : 1000000 -current_clients : 250040 -shutdown_count : [] -listener on http:18083 -acceptors : 4 -max_clients : 512 -current_clients : 0 -shutdown_count : [] -``` - -./bin/emqttd_ctl vm ------------------------ - -``` -cpu/load1 : 13.44 -cpu/load5 : 10.43 -cpu/load15 : 5.98 -memory/total : 2710277048 -memory/processes : 1420519328 -memory/processes_used : 1419564424 -memory/system : 1289757720 -memory/atom : 512601 -memory/atom_used : 486464 -memory/binary : 380872488 -memory/code : 13077799 -memory/ets : 408483440 -process/limit : 1048576 -process/count : 500353 -io/max_fds : 500000 -io/active_fds : 75 -``` - -./bin/emqttd_ctl recon node_stats ---------------------------------- - -``` -{[{process_count,500353}, -{run_queue,41}, -{error_logger_queue_len,0}, -{memory_total,2698242896}, -{memory_procs,1408734784}, -{memory_atoms,486706}, -{memory_bin,380825008}, -{memory_ets,408483456}], -[{bytes_in,256851}, -{bytes_out,1202095}, -{gc_count,24423}, -{gc_words_reclaimed,4092612}, -{reductions,1850034}, -{scheduler_usage,[{1,0.46640942781698586}, -{2,0.5293768498814092}, -{3,0.441425019999723}, -{4,0.45550895378436373}, -{5,0.45318168320081786}, -{6,0.4627325387117833}, -{7,0.5144161001107628}, -{8,0.46406643808409137}]}]} -``` diff --git a/docs/source/tune/etc_app_config.rst b/docs/source/tune/etc_app_config.rst deleted file mode 100644 index 5d7910c1f..000000000 --- a/docs/source/tune/etc_app_config.rst +++ /dev/null @@ -1,32 +0,0 @@ -etc/app.config for C1000K -========================= - -:: - - {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 - ]}, - - %% Socket Options - {sockopts, [ - %Tune buffer if hight thoughtput - %{recbuf, 4096}, - %{sndbuf, 4096}, - %{buffer, 4096}, - %{nodelay, true}, - {backlog, 1024} - ]} - ]}, - diff --git a/docs/source/tune/etc_vm_args.rst b/docs/source/tune/etc_vm_args.rst deleted file mode 100644 index e6dfb8e4d..000000000 --- a/docs/source/tune/etc_vm_args.rst +++ /dev/null @@ -1,26 +0,0 @@ - -etc/vm.args for C1000K -====================== - -:: - - ## 12 threads/core. - +A 64 - - ## Max process numbers > connections * 2 - ## 2M - +P 2097152 - - ## Sets the maximum number of simultaneously existing ports for this system - ## 1M - +Q 1048576 - - ## Increase number of concurrent ports/sockets, deprecated in R17 - -env ERL_MAX_PORTS 1048576 - - -env ERTS_MAX_PORTS 1048576 - - ## Mnesia and SSL will create temporary ets tables - ## 16K - -env ERL_MAX_ETS_TABLES 16384 - diff --git a/docs/source/tune/index.rst b/docs/source/tune/index.rst deleted file mode 100644 index be376d815..000000000 --- a/docs/source/tune/index.rst +++ /dev/null @@ -1,12 +0,0 @@ - -Tune Guide ----------- - -.. toctree:: - :maxdepth: 1 - - linux_kernel_tuning - etc_vm_args - etc_app_config - benchmark_0.13.0 - diff --git a/docs/source/tune/linux_kernel_tuning.rst b/docs/source/tune/linux_kernel_tuning.rst deleted file mode 100644 index b15d8d038..000000000 --- a/docs/source/tune/linux_kernel_tuning.rst +++ /dev/null @@ -1,175 +0,0 @@ - -Linux Kernel Tuning for C1000K concurrent connections:: - - # system-wide limit on max opened files for all processes - # sysctl -n fs.nr_open - # 1M - sysctl -w fs.file-max=1048576 - sysctl -w fs.nr_open=1048576 - ulimit -n 1048576 - # Increase number of incoming connections - net.core.somaxconn = 65536 - - sysctl -w net.ipv4.tcp_mem='10000000 10000000 10000000' - sysctl -w net.ipv4.tcp_rmem='1024 4096 16384' - sysctl -w net.ipv4.tcp_wmem='1024 4096 16384' - sysctl -w net.core.rmem_max=16384 - sysctl -w net.core.wmem_max=16384 - - net.core.rmem_max = 16777216 - net.core.wmem_max = 16777216 - net.core.rmem_default = 16777216 - net.core.wmem_default = 16777216 - net.core.optmem_max = 2048000 - net.core.netdev_max_backlog = 50000 - - net.ipv4.tcp_rmem = 4096 4096 16777216 - net.ipv4.tcp_wmem = 4096 4096 16777216 - net.ipv4.tcp_max_syn_backlog = 30000 - net.ipv4.tcp_max_tw_buckets = 2000000 - net.ipv4.tcp_tw_reuse = 1 - net.ipv4.tcp_fin_timeout = 10 - net.ipv4.conf.all.send_redirects = 0 - net.ipv4.conf.all.accept_redirects = 0 - net.ipv4.conf.all.accept_source_route = 0 - net.ipv4.tcp_slow_start_after_idle = 0 - net.ipv4.ip_local_port_range = 8000 65535 - - net.netfilter.nf_conntrack_max = 1000000 - net.netfilter.nf_conntrack_tcp_timeout_time_wait = 30 - - vm.min_free_kbytes = 65536 - vm.swappiness = 0 - vm.overcommit_memory = 1 - - -/etc/sysctl.conf ----------------- - -:: - - fs.file-max = 1048576 - - -/etc/security/limits.conf -------------------------- - -:: - - * soft nofile 1048576 - * hard nofile 1048576 - - - ## Kernel/Network Tunings from @galvezlj - - Server side: - ``` - fs.file-max = 1000000 - net.core.somaxconn = 65536 - net.ipv4.ip_local_port_range = 500 65535 - net.nf_conntrack_max = 1000000 - net.netfilter.nf_conntrack_max = 1000000 - net.ipv4.tcp_rmem = 4096 4096 16777216 - net.ipv4.tcp_wmem = 4096 4096 16777216 - ``` - - Client side: - - ``` - sysctl -w net.ipv4.ip_local_port_range="500 65535" - echo 1000000 > /proc/sys/fs/nr_open - ``` - - ## Kernel/Network Tunings from my benchmark server - - ``` - fs.file-max = 1000000 - - net.core.somaxconn = 65536 - net.core.wmem_max = 124928 - net.core.rmem_max = 124928 - net.core.wmem_default = 124928 - net.core.rmem_default = 124928 - net.core.dev_weight = 64 - net.core.netdev_max_backlog = 1000 - net.core.message_cost = 5 - net.core.message_burst = 10 - net.core.optmem_max = 20480 - net.core.busy_poll = 0 - net.core.busy_read = 0 - net.core.netdev_budget = 300 - - net.ipv4.tcp_timestamps = 1 - net.ipv4.tcp_window_scaling = 1 - net.ipv4.tcp_sack = 1 - net.ipv4.tcp_retrans_collapse = 1 - net.ipv4.ip_default_ttl = 64 - net.ipv4.tcp_syn_retries = 5 - net.ipv4.tcp_synack_retries = 5 - net.ipv4.tcp_max_orphans = 262144 - net.ipv4.tcp_max_tw_buckets = 262144 - net.ipv4.ip_dynaddr = 0 - net.ipv4.tcp_keepalive_time = 7200 - net.ipv4.tcp_keepalive_probes = 9 - net.ipv4.tcp_keepalive_intvl = 75 - net.ipv4.tcp_retries1 = 3 - net.ipv4.tcp_retries2 = 15 - net.ipv4.tcp_fin_timeout = 60 - net.ipv4.tcp_syncookies = 1 - net.ipv4.tcp_tw_recycle = 0 - net.ipv4.tcp_abort_on_overflow = 0 - net.ipv4.tcp_max_syn_backlog = 2048 - net.ipv4.ip_local_port_range = 32768 61000 - net.ipv4.inet_peer_threshold = 65664 - net.ipv4.inet_peer_minttl = 120 - net.ipv4.inet_peer_maxttl = 600 - net.ipv4.inet_peer_gc_mintime = 10 - net.ipv4.inet_peer_gc_maxtime = 120 - net.ipv4.tcp_mem = 3080640 4107520 6161280 - net.ipv4.tcp_wmem = 4096 16384 4194304 - net.ipv4.tcp_rmem = 4096 87380 4194304 - net.ipv4.tcp_app_win = 31 - net.ipv4.tcp_adv_win_scale = 2 - net.ipv4.tcp_tw_reuse = 0 - net.ipv4.tcp_frto = 2 - net.ipv4.tcp_frto_response = 0 - net.ipv4.tcp_low_latency = 0 - net.ipv4.tcp_no_metrics_save = 0 - net.ipv4.tcp_moderate_rcvbuf = 1 - net.ipv4.tcp_tso_win_divisor = 3 - net.ipv4.tcp_congestion_control = cubic - net.ipv4.tcp_abc = 0 - net.ipv4.tcp_mtu_probing = 0 - net.ipv4.tcp_base_mss = 512 - net.ipv4.tcp_workaround_signed_windows = 0 - net.ipv4.tcp_challenge_ack_limit = 100 - net.ipv4.tcp_limit_output_bytes = 131072 - net.ipv4.tcp_dma_copybreak = 4096 - net.ipv4.tcp_slow_start_after_idle = 1 - net.ipv4.tcp_available_congestion_control = cubic reno - net.ipv4.tcp_allowed_congestion_control = cubic reno - net.ipv4.tcp_max_ssthresh = 0 - net.ipv4.tcp_thin_linear_timeouts = 0 - net.ipv4.tcp_thin_dupack = 0 - net.ipv4.tcp_min_tso_segs = 2 - net.ipv4.udp_mem = 3080640 4107520 6161280 - net.ipv4.udp_rmem_min = 4096 - net.ipv4.udp_wmem_min = 4096 - net.ipv4.conf.all.forwarding = 0 - net.ipv4.conf.all.mc_forwarding = 0 - net.ipv4.conf.all.accept_redirects = 1 - net.ipv4.conf.all.secure_redirects = 1 - net.ipv4.conf.all.shared_media = 1 - net.ipv4.conf.all.rp_filter = 0 - net.ipv4.conf.all.send_redirects = 1 - net.ipv4.conf.all.src_valid_mark = 0 - net.ipv4.conf.all.medium_id = 0 - net.ipv4.conf.all.bootp_relay = 0 - net.ipv4.conf.all.log_martians = 0 - net.ipv4.conf.all.tag = 0 - - vm.min_free_kbytes = 67584 - vm.swappiness = 60 - vm.overcommit_memory = 0 - ``` - diff --git a/docs/source/user/acl.rst b/docs/source/user/acl.rst deleted file mode 100644 index b2cc4144d..000000000 --- a/docs/source/user/acl.rst +++ /dev/null @@ -1,4 +0,0 @@ - -ACL -=== - diff --git a/docs/source/user/admin.rst b/docs/source/user/admin.rst deleted file mode 100644 index d4856f98f..000000000 --- a/docs/source/user/admin.rst +++ /dev/null @@ -1,5 +0,0 @@ - -Admin -===== - - diff --git a/docs/source/user/authentication.rst b/docs/source/user/authentication.rst deleted file mode 100644 index 896b363e9..000000000 --- a/docs/source/user/authentication.rst +++ /dev/null @@ -1,3 +0,0 @@ -Authentication -============== - diff --git a/docs/source/user/clustering.rst b/docs/source/user/clustering.rst deleted file mode 100644 index d138108c1..000000000 --- a/docs/source/user/clustering.rst +++ /dev/null @@ -1,61 +0,0 @@ - -Clustering -========== - -Suppose we cluster two nodes on hosts: - -Node | Host | IpAddress ------|--------|------------- -node1(disc_copy)| host1 | 192.168.0.10 -node2(ram_copy) | host2 | 192.168.0.20 - - -Configure and start 'node1' ---------------------------- - -configure 'etc/vm.args':: - - -name emqttd@192.168.0.10 - -If host1, host2 added to /etc/hosts of OS:: - - -name emqttd@host1 - -Start node1:: - - ./bin/emqttd start - -.. NOTE:: Notice that data/mnesia/* should be removed before you start the broker with different node name. - - -Configure and start 'node2' ---------------------------- - -Configure 'etc/vm.args':: - - -name emqttd@192.168.0.20 - -or:: - - -name emqttd@host2 - - -Then start node2:: - - ./bin/emqttd start - -Cluster two nodes ---------------------------- - -Run './bin/emqttd_ctl cluster' on host2:: - - ./bin/emqttd_ctl cluster emqttd@192.168.0.10 - - -Check cluster status ---------------------------- - -And then check clustered status on any host:: - - ./bin/emqttd_ctl cluster - diff --git a/docs/source/user/configuration.rst b/docs/source/user/configuration.rst deleted file mode 100644 index e50a343af..000000000 --- a/docs/source/user/configuration.rst +++ /dev/null @@ -1,382 +0,0 @@ - -Configuration -============= - -TODO:... - -Configuration files include: - -+-------------------+-----------------------------------+ -| File | Description | -+-------------------+-----------------------------------+ -| etc/vm.args | Erlang VM Arguments | -+-------------------+-----------------------------------+ -| etc/app.config | emqttd Broker Configuration | -+-------------------+-----------------------------------+ -| etc/acl.config | ACL Rules Config | -+-------------------+-----------------------------------+ -| etc/clients.config| Authentication with clientId | -+-------------------+-----------------------------------+ -| etc/ssl/* | SSL certificate and key files | -+-------------------+-----------------------------------+ - - -etc/vm.args ------------ - -Configure/Optimize the Erlang VM:: - - ##------------------------------------------------------------------------- - ## 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 - - -.. NOTE:: +P Number > 2 * Max Connections - - -etc/app.config --------------- - -TODO: The main configuration file for emqttd broker. Configure authentication, ACL, mqtt protocol parameters and listeners of the broker. - -TODO: The file is erlang format. - -Authentication and ACL:: - - %% Authentication and Authorization - {access, [ - %% Authetication. Anonymous Default - {auth, [ - %% Authentication with username, password - %{username, []}, - - %% Authentication with clientid - %{clientid, [{password, no}, {file, "etc/clients.config"}]}, - - %% Authentication with LDAP - % {ldap, [ - % {servers, ["localhost"]}, - % {port, 389}, - % {timeout, 30}, - % {user_dn, "uid=$u,ou=People,dc=example,dc=com"}, - % {ssl, fasle}, - % {sslopts, [ - % {"certfile", "ssl.crt"}, - % {"keyfile", "ssl.key"}]} - % ]}, - - %% Allow all - {anonymous, []} - ]}, - %% ACL config - {acl, [ - %% Internal ACL module - {internal, [{file, "etc/acl.config"}, {nomatch, allow}]} - ]} - ]}, - - -MQTT Packet, Client, Session, MQueue:: - - {mqtt, [ - %% Packet - {packet, [ - %% Max ClientId Length Allowed - {max_clientid_len, 1024}, - %% Max Packet Size Allowed, 64K default - {max_packet_size, 65536} - ]}, - %% Client - {client, [ - %% Socket is connected, but no 'CONNECT' packet received - {idle_timeout, 20} %% seconds - %TODO: Network ingoing limit - %{ingoing_rate_limit, '64KB/s'} - %TODO: Reconnet control - ]}, - %% Session - {session, [ - %% Max number of QoS 1 and 2 messages that can be “in flight” at one time. - %% 0 means no limit - {max_inflight, 100}, - - %% Retry interval for redelivering QoS1/2 messages. - {unack_retry_interval, 60}, - - %% Awaiting PUBREL Timeout - {await_rel_timeout, 20}, - - %% Max Packets that Awaiting PUBREL, 0 means no limit - {max_awaiting_rel, 0}, - - %% Statistics Collection Interval(seconds) - {collect_interval, 0}, - - %% Expired after 2 days - {expired_after, 48} - - ]}, - %% Session - {queue, [ - %% Max queue length. enqueued messages when persistent client disconnected, - %% or inflight window is full. - {max_length, 100}, - - %% Low-water mark of queued messages - {low_watermark, 0.2}, - - %% High-water mark of queued messages - {high_watermark, 0.6}, - - %% Queue Qos0 messages? - {queue_qos0, true} - ]} - ]}, - -Broker Options:: - - {broker, [ - %% System interval of publishing broker $SYS messages - {sys_interval, 60}, - - %% Retained messages - {retained, [ - %% Expired after seconds, never expired if 0 - {expired_after, 0}, - - %% Max number of retained messages - {max_message_num, 100000}, - - %% Max Payload Size of retained message - {max_playload_size, 65536} - ]}, - - %% PubSub and Router - {pubsub, [ - %% Default should be scheduler numbers - %% {pool_size, 8}, - - %% Subscription: disc | ram | false - {subscription, ram}, - - %% Route shard - {route_shard, false}, - - %% Route delay, false | integer - {route_delay, false}, - - %% Route aging time(seconds) - {route_aging, 5} - ]}, - - %% Bridge - {bridge, [ - %%TODO: bridge queue size - {max_queue_len, 10000}, - - %% Ping Interval of bridge node - {ping_down_interval, 1} %seconds - ]} - ]}, - -Extended Modules:: - - {modules, [ - %% Client presence management module. - %% Publish messages when client connected or disconnected - {presence, [{qos, 0}]} - - %% Subscribe topics automatically when client connected - %% {subscription, [ - %% %% Subscription from stored table - %% stored, - %% - %% %% $u will be replaced with username - %% {"$Q/username/$u", 1}, - %% - %% %% $c will be replaced with clientid - %% {"$Q/client/$c", 1} - %% ]} - - %% Rewrite rules - %% {rewrite, [{file, "etc/rewrite.config"}]} - ]}, - -Listeners:: - - {listeners, [ - {mqtt, 1883, [ - %% Size of acceptor pool - {acceptors, 16}, - - %% Maximum number of concurrent clients - {max_clients, 8192}, - - %% 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 - ]}, - - %% Socket Options - {sockopts, [ - %Set buffer if hight thoughtput - %{recbuf, 4096}, - %{sndbuf, 4096}, - %{buffer, 4096}, - %{nodelay, true}, - {backlog, 1024} - ]} - ]}, - - {mqtts, 8883, [ - %% Size of acceptor pool - {acceptors, 4}, - - %% Maximum number of concurrent clients - {max_clients, 512}, - - %% Socket Access Control - {access, [{allow, all}]}, - - %% SSL certificate and key files - {ssl, [{certfile, "etc/ssl/ssl.crt"}, - {keyfile, "etc/ssl/ssl.key"}]}, - - %% Socket Options - {sockopts, [ - {backlog, 1024} - %{buffer, 4096}, - ]} - ]}, - %% WebSocket over HTTPS Listener - %% {https, 8083, [ - %% %% Size of acceptor pool - %% {acceptors, 4}, - %% %% Maximum number of concurrent clients - %% {max_clients, 512}, - %% %% Socket Access Control - %% {access, [{allow, all}]}, - %% %% SSL certificate and key files - %% {ssl, [{certfile, "etc/ssl/ssl.crt"}, - %% {keyfile, "etc/ssl/ssl.key"}]}, - %% %% Socket Options - %% {sockopts, [ - %% %{buffer, 4096}, - %% {backlog, 1024} - %% ]} - %%]}, - - %% HTTP and WebSocket Listener - {http, 8083, [ - %% Size of acceptor pool - {acceptors, 4}, - %% Maximum number of concurrent clients - {max_clients, 64}, - %% Socket Access Control - {access, [{allow, all}]}, - %% Socket Options - {sockopts, [ - {backlog, 1024} - %{buffer, 4096}, - ]} - ]} - ]}, - - -etc/acl.config --------------- - -Configuration file for ACL:: - - %%%----------------------------------------------------------------------------- - %%% - %%% -type who() :: all | binary() | - %%% {ipaddr, esockd_access:cidr()} | - %%% {client, binary()} | - %%% {user, binary()}. - %%% - %%% -type access() :: subscribe | publish | pubsub. - %%% - %%% -type topic() :: binary(). - %%% - %%% -type rule() :: {allow, all} | - %%% {allow, who(), access(), list(topic())} | - %%% {deny, all} | - %%% {deny, who(), access(), list(topic())}. - %%% - %%%----------------------------------------------------------------------------- - - {allow, {user, "dashboard"}, subscribe, ["$SYS/#"]}. - - {allow, {ipaddr, "127.0.0.1"}, pubsub, ["$SYS/#", "#"]}. - - {deny, all, subscribe, ["$SYS/#", {eq, "#"}]}. - - {allow, all}. - -.. NOTE:: Allow 'localhost' to pubsub '$SYS/#' and '#' by default. - -etc/clients.config ------------------- - -TODO: - -testclientid0 -testclientid1 127.0.0.1 -testclientid2 192.168.0.1/24 - - - diff --git a/docs/source/user/emqttd_init.rst b/docs/source/user/emqttd_init.rst deleted file mode 100644 index 4cedf071f..000000000 --- a/docs/source/user/emqttd_init.rst +++ /dev/null @@ -1,74 +0,0 @@ - -/etc/init.d/emqttd -================== - -:: - #!/bin/sh - # - # emqttd Startup script for emqttd. - # - # chkconfig: 2345 90 10 - # description: emqttd is mqtt broker. - - # source function library - . /etc/rc.d/init.d/functions - - # export HOME=/root - - start() { - echo "starting emqttd..." - cd /opt/emqttd && ./bin/emqttd start - } - - stop() { - echo "stopping emqttd..." - cd /opt/emqttd && ./bin/emqttd stop - } - - restart() { - stop - start - } - - case "$1" in - start) - start - ;; - stop) - stop - ;; - restart) - restart - ;; - *) - echo $"Usage: $0 {start|stop}" - RETVAL=2 - esac - -chkconfig ---------- - -:: - - chmod +x /etc/init.d/emqttd - chkconfig --add emqttd - chkconfig --list - -boot test on ubuntu -------------------- - -:: - service emqttd start - -erlexec: HOME must be set -------------------- - -uncomment '# export HOME=/root' if "HOME must be set" error. - - -Referrence ---------- - -.. `How to make unix service see environment variables?`_: http://unix.stackexchange.com/questions/44370/how-to-make-unix-service-see-environment-variables/44378#44378 - - diff --git a/docs/source/user/http.rst b/docs/source/user/http.rst deleted file mode 100644 index e09652dc7..000000000 --- a/docs/source/user/http.rst +++ /dev/null @@ -1,33 +0,0 @@ - -HTTP API -======== - -emqttd support HTTP API to publish message from your application server to MQTT clients. For example:: - - curl -v --basic -u user:passwd -d "qos=1&retain=0&topic=/a/b/c&message=hello from http..." -k http://localhost:8083/mqtt/publish - -HTTP API URL ------------ - -:: - HTTP POST http://host:8083/mqtt/publish - - -HTTP Parameters ---------------- - -+---------+-----------------+ -| Name | Description | -+-------------------+-------+ -| client | ClientId | -+-------------------+-------+ -| qos | QoS(0, 1, 2) | -+-------------------+-------+ -| retain | Retain(0, 1) | -+-------------------+-------+ -| topic | Topic | -+-------------------+-------+ -| message | Message | -+-------------------+-------+ - - diff --git a/docs/source/user/index.rst b/docs/source/user/index.rst deleted file mode 100644 index bc9aad214..000000000 --- a/docs/source/user/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -User Guide ----------- - -.. toctree:: - :maxdepth: 2 - - install - configuration - authentication - acl - http - websocket - admin - systopics - logs - trace - diff --git a/docs/source/user/install.rst b/docs/source/user/install.rst deleted file mode 100644 index 6e1c9529f..000000000 --- a/docs/source/user/install.rst +++ /dev/null @@ -1,99 +0,0 @@ -Installation -============ - -TODO: ... - -emqttd is cross-platform, could run on windows, linux, freebsd and mac os x. - -emqttd is easy to install and takes about 5 minutes to download and startup. - -Install on Linux, Freebsd and Mac OS X --------------------------------------- - -Download binary packages from http://emqtt.io/downloads, and then:: - - unzip emqttd-platform-0.x.y-beta.zip && cd emqttd - -Startup with console for debug:: - - ./bin/emqttd console - -All the MQTT Packets(RECV/SENT) will be printed on console. - -Startup as daemon:: - - ./bin/emqttd start - -TCP Ports used by emqttd: - -+-----------+-----------------------------+ -| Port | Description | -+-----------+-----------------------------+ -| 1883 | MQTT | -+-----------+-----------------------------+ -| 8883 | MQTT(SSL) | -+-----------+-----------------------------+ -| 8083 | MQTT Over WebSocket | -+-----------+-----------------------------+ - - -Check the broker status:: - - ./bin/emqttd_ctl status - -Stop the broker:: - - ./bin/emqttd stop - - -Install on Windows ------------------- - -Download windows package from http://emqtt.io/downloads. - -Start console to check if emqttd works:: - - .\bin\emqttd console - -.. NOTE:: execute '.\bin\emqttd', should not cd to 'bin' folder. - -A console window will show if the broker started successfully. - -Register emqttd as window service:: - - .\bin\emqttd install - -Starte emqttd service:: - - .\bin\emqttd start - -.. NOTE:: The console window should be closed if opened. - -Stop emqttd service:: - - .\bin\emqttd stop - -Uninstall emqttd service:: - - .\bin\emqttd uninstall - - -Build from Source ------------------ - -emqttd requires Erlang R17+ to build from source. - -Erlang R17+ and git client should be installed before building emqttd. - -:: - - git clone https://github.com/emqtt/emqttd.git - - cd emqttd - - git submodule update --init --recursive - - make && make dist - - cd rel/emqttd && ./bin/emqttd console - diff --git a/docs/source/user/logs.rst b/docs/source/user/logs.rst deleted file mode 100644 index 9518ee5ca..000000000 --- a/docs/source/user/logs.rst +++ /dev/null @@ -1,4 +0,0 @@ - -Logs -==== - diff --git a/docs/source/user/systopics.rst b/docs/source/user/systopics.rst deleted file mode 100644 index 7a8197dc2..000000000 --- a/docs/source/user/systopics.rst +++ /dev/null @@ -1,205 +0,0 @@ - -$SYS Topics -=========== - -$SYS Topics of broker is started with:: - - $SYS/brokers/${node} - -${node} is erlang node name of clustered brokers. For example:: - - $SYS/brokers/emqttd@host1/version - $SYS/brokers/emqttd@host2/version - -Broker $SYS Topics ------------------- - -Topic | Description --------------------------------|------------ -$SYS/brokers | Broker nodes -$SYS/brokers/${node}/version | Broker Version -$SYS/brokers/${node}/uptime | Broker Uptime -$SYS/brokers/${node}/datetime | Broker DateTime -$SYS/brokers/${node}/sysdescr | Broker Description -  -Client $SYS Topics ------------------- - -Start with: $SYS/brokers/${node}/clients/ - -Topic | Payload(json) | Description -----------------------|---------------------|--------------- -${clientid}/connected | {ipaddress: "127.0.0.1", username: "test", session: false, version: 3, connack: 0, ts: 1432648482} | Publish when client connected -${clientid}/disconnected | {reason: "normal" | "keepalive_timeout" | "conn_closed"} - -Parameters of 'connected' Payload:: - - ipaddress: "127.0.0.1", - username: "test", - session: false, - protocol: 3, - connack: 0, - ts: 1432648482 - -Parameters of 'disconnected' Payload:: - - reason: normal, - ts: 1432648486 - -Statistics $SYS Topics ----------------------- - -Start with '$SYS/brokers/${node}/stats/' - -Client Stats ----------------------- - -Topic | Description --------------------------------------|------------ -clients/count | count of current connected clients -clients/max | max connected clients in the same time - -Session Stats ----------------------- - -Topic | Description ------------------|------------ -sessions/count | count of current sessions -sessions/max | max number of sessions - -Subscriber Stats ----------------------- - -Topic | Description -------------------|------------ -subscriptions/count | count of current subscriptions -subscriptions/max | max number of subscriptions - -Topic Stats ----------------------- - -Topic | Description -------------------|------------ -topics/count | count of current topics -topics/max | max number of topics - -Queue Stats ----------------------- - -Topic | Description -------------------|------------ -queues/count | count of current queues -queues/max | max number of queues - - -Metrics $SYS Topics ----------------------- - -Start with '$SYS/brokers/${node}/metrics/' - -Bytes sent and received ----------------------- - -Topic | Description -------------------------------------|------------ -bytes/received | MQTT Bytes Received since broker started -bytes/sent | MQTT Bytes Sent since the broker started - -Packets sent and received -------------------------- - -Topic | Description --------------------------|------------ -packets/received | MQTT Packets received -packets/sent | MQTT Packets sent -packets/connect | MQTT CONNECT Packet received -packets/connack | MQTT CONNACK Packet sent -packets/publish/received | MQTT PUBLISH packets received -packets/publish/sent | MQTT PUBLISH packets sent -packets/subscribe | MQTT SUBSCRIBE Packets received -packets/suback | MQTT SUBACK packets sent -packets/unsubscribe | MQTT UNSUBSCRIBE Packets received -packets/unsuback | MQTT UNSUBACK Packets sent -packets/pingreq | MQTT PINGREQ packets received -packets/pingresp | MQTT PINGRESP Packets sent -packets/disconnect | MQTT DISCONNECT Packets received - -Messages sent and received ---------------------------- - -Topic | Description ----------------------------------------|------------------- -messages/received | Messages Received -messages/sent | Messages Sent -messages/retained | Messages Retained -messages/stored | TODO: Messages Stored -messages/dropped | Messages Dropped - -Alarm Topics ---------------------------- - -Start with '$SYS/brokers/${node}/alarms/' - -Topic | Description ------------------|------------------- -${alarmId}/alert | New Alarm -${alarmId}/clear | Clear Alarm - -Logs ---------------------------- - -'$SYS/brokers/${node}/logs/${severity}' - -Severity | Description ------------|------------------- -debug | Debug Log -info | Info Log -notice | Notice Log -warning | Warning Log -error | Error Log -critical | Critical Log - -Sysmon ---------------------------- - -Start with '$SYS/brokers/${node}/sysmon/' - -Topic | Description ------------------|------------------- -long_gc | Long GC Warning -long_schedule | Long Schedule -large_heap | Large Heap Warning -busy_port | Busy Port Warning -busy_dist_port | Busy Dist Port - -Logs(TODO) ---------------------------- - -'$SYS/brokers/${node}/log/${severity}' - -Severity | Description -------------|------------------- -debug | Debug -info | Info Log -notice | Notice Log -warning | Warning Log -error | Error Log -critical | Critical Log -alert | Alert Log - -VM Load Topics(TODO) ---------------------------- - -Start with '$SYS/brokers/${node}/vm/' - -Topic | Description ------------------|------------------- -memory/* | TODO -cpu/* | TODO -processes/* | TODO - -Sys Interval ---------------------------- - -sys_interval: 1 minute default - diff --git a/docs/source/user/trace.rst b/docs/source/user/trace.rst deleted file mode 100644 index d33f80106..000000000 --- a/docs/source/user/trace.rst +++ /dev/null @@ -1,37 +0,0 @@ - -emqttd could trace packets received/sent from/to specific client, or trace publish/subscribe to specific topic. - -emqttd use lager:trace_file api and write trace log to file. - -TODO: NOTICE - -Trace client -------------- - - -``` -./bin/emqttd_ctl trace client "ClientId" "trace_clientid.log" -``` - -Trace topic -------------- - -``` -./bin/emqttd_ctl trace topic "Topic" "trace_topic.log" -``` - -Stop Trace -------------- - -``` -./bin/emqttd_ctl trace client "ClientId" off -./bin/emqttd_ctl trace topic "Topic" off -``` - -Lookup Traces -------------- - -``` -./bin/emqttd_ctl trace list -``` - diff --git a/docs/source/user/websocket.rst b/docs/source/user/websocket.rst deleted file mode 100644 index f7f60d605..000000000 --- a/docs/source/user/websocket.rst +++ /dev/null @@ -1,20 +0,0 @@ - -WebSocket -========= - -emqttd supports MQTT over WebSocket(SSL). - -URI ----- - -:: - ws(s)://host:8083/mqtt - -Sec-WebSocket-Protocol ----------------------- - -:: - 'mqttv3.1', 'mqttv3.1.1' - - -