Preprocess all documentation

Antonio Terceiro
1 parent 84b6e8d2
Showing 18 changed files with 583 additions and 510 deletions Show diff stats
docs/.gitignore
docs/arquitetura.rst
docs/arquitetura.rst.in
docs/backup.rst
docs/backup.rst.in
docs/conf.py
docs/conf.py.in
docs/firewall.rst
docs/firewall.rst.in
docs/firewall.rstin
docs/implantacao.rst.in
docs/index.rst
docs/index.rst.in
docs/introducao.rst
docs/introducao.rst.in
docs/local.mk
docs/manutencao.rst
docs/manutencao.rst.in
 architecture.png
-implantacao.rst
+*.rst
+conf.py
@@ -1,18 +0,0 @@
-Arquitetura
-===========
-
-A figura a seguir representa a arquitetura do SPB.
-
-.. TODO incluir uma figura feita manualmente, a gente deve ter isso de
-.. apresentações anterires
-.. image:: architecture.png
-
-TODO:
-
-* descrever arquitetura
-* descrever papel de cada máquina
-* descrever conexões
-* adicionar links com o repositório de gestão de configuração
-
-* descrever repositório de gestão de configuração
-* descrever como o chake funciona
@@ -0,0 +1,18 @@
+Arquitetura
+===========
+
+A figura a seguir representa a arquitetura do SPB.
+
+.. TODO incluir uma figura feita manualmente, a gente deve ter isso de
+.. apresentações anterires
+.. image:: architecture.png
+
+TODO:
+
+* descrever arquitetura
+* descrever papel de cada máquina
+* descrever conexões
+* adicionar links com o repositório de gestão de configuração
+
+* descrever repositório de gestão de configuração
+* descrever como o chake funciona
@@ -1,4 +0,0 @@
-Backup
-======
-
-
@@ -0,0 +1,4 @@
+Backup
+======
+
+
@@ -1,331 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# softwarepublico documentation build configuration file, created by
-# sphinx-quickstart on Thu Nov  6 15:48:07 2014.
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import sys
-import os
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
-
-# -- 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 = []
-
-# 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'softwarepublico'
-copyright = u'2014-2015, Universidade de Brasília - UnB. Documentação licenciada sob a Licença Creative Commons Atribuição-CompartilhaIgual 4.0 Internacional'
-
-# 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 = '2.0'
-# The full version, including alpha/beta/rc tags.
-release = '2.0'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-language = 'pt_BR'
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['_build']
-
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-# If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
-
-
-# -- Options for HTML output ----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-html_theme = '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
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# Add any extra paths that contain custom files (such as robots.txt or
-# .htaccess) here, relative to this directory. These files are copied
-# directly to the root of the documentation.
-#html_extra_path = []
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# 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 <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'softwarepublicodoc'
-
-
-# -- 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', 'softwarepublico.tex',
-   u'Software Público Brasileiro: Manual de Operação',
-   u'Universidade de Brasília', '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', 'softwarepublico',
-     u'Documentação - Software Público Brasileiro (SPB)',
-     [u'Universidade de Brasília'], 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', 'softwarepublico',
-   u'Documentação - Software Público Brasileiro (SPB)',
-   u'Universidade de Brasília', 'softwarepublico', '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'softwarepublico'
-epub_author = u'Universidade de Brasília'
-epub_publisher = u'Universidade de Brasília'
-epub_copyright = u'2014, Universidade de Brasília. Documentação licenciada sob a Licença Crea  tive Commons Atribuição-CompartilhaIgual 4.0 Internacional'
-
-# The basename for the epub file. It defaults to the project name.
-#epub_basename = u'softwarepublico'
-
-# 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
@@ -0,0 +1,331 @@
+# -*- coding: utf-8 -*-
+#
+# softwarepublico documentation build configuration file, created by
+# sphinx-quickstart on Thu Nov  6 15:48:07 2014.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- 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 = []
+
+# 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'softwarepublico'
+copyright = u'2014-2015, Universidade de Brasília - UnB. Documentação licenciada sob a Licença Creative Commons Atribuição-CompartilhaIgual 4.0 Internacional'
+
+# 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 = '2.0'
+# The full version, including alpha/beta/rc tags.
+release = '2.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+language = 'pt_BR'
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = '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
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# 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 <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'softwarepublicodoc'
+
+
+# -- 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', 'softwarepublico.tex',
+   u'Software Público Brasileiro: Manual de Operação (@@SPB_ENV@@)',
+   u'Universidade de Brasília', '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', 'softwarepublico',
+     u'Documentação - Software Público Brasileiro (SPB)',
+     [u'Universidade de Brasília'], 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', 'softwarepublico',
+   u'Documentação - Software Público Brasileiro (SPB)',
+   u'Universidade de Brasília', 'softwarepublico', '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'softwarepublico'
+epub_author = u'Universidade de Brasília'
+epub_publisher = u'Universidade de Brasília'
+epub_copyright = u'2014, Universidade de Brasília. Documentação licenciada sob a Licença Crea  tive Commons Atribuição-CompartilhaIgual 4.0 Internacional'
+
+# The basename for the epub file. It defaults to the project name.
+#epub_basename = u'softwarepublico'
+
+# 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
@@ -1,65 +0,0 @@
-Gestão do Firewall
-==================
-
-Firewall Interno
------------------
-
-O Portal do Software Público atualmente é composto por diversos serviços funcionando em diferentes servidores. Para o seu correto funcionamento é esperado que estes serviços se comuniquem através de TCP/IP. 
-
-Os scripts de instalação do Portal do Software Público também cuidam da manutenção das regras de firewall. Cada máquina possui um firewall (iptables) local que por padrão nega todos os tipos de conexão de entrada em todas as portas (INPUT rules) mas permite conexões de saída (OUTPUT rules).
-
-Todas as regras de firewall são definidas no cookbook ``firewall``. Para definir regras de comunidacação entre hosts locais, válidas para todos os ambientes (local, produção, homologação, testes, etc) são utilizados templates que podem ser encontrados em ``cookbooks/firewall/templates/``. Para regras de filtro utilize o arquivo ``iptables-filter.erb`` e para regras de nat o arquivo ``iptables-nat.erb``. 
-
-Para adicionar regras específicas de cada ambiente (por exemplo, abrir uma porta diferente em homologação) utilize o arquivo ``config/<nome_do_ambiente>/iptables-filter-rules``. Este arquivo aceita apenas regras de filtro do tipo INPUT.
-
-
-Comunicação Entre Serviços
-++++++++++++++++++++++++++++
-
-Os serviços que compõe o portal e suas portas de entrada são descritos na tabela a seguir:
-
-+--------------+--------------+---------------+--------+
-| Destino      | Origem       + Serviço       | Porta  |
-+==============+==============+===============+========+
-| database     | integration  | Redis         | 6379   |
-+--------------+--------------+---------------+--------+
-| database     | integration  | PostgreSQL    | 5432   |
-+--------------+--------------+---------------+--------+
-| database     | social       | PostgreSQL    | 5432   |
-+--------------+--------------+---------------+--------+
-| social       | reverseproxy | Nginx         | 80     |
-+--------------+--------------+---------------+--------+
-| social       | reverseproxy | Nginx         | 443    |
-+--------------+--------------+---------------+--------+
-| integration  | reverseproxy | Nginx         | 80     |
-+--------------+--------------+---------------+--------+
-| integration  | reverseproxy | Nginx         | 443    |
-+--------------+--------------+---------------+--------+
-| email        | externa      | Postfix       | 25     |
-+--------------+--------------+---------------+--------+
-| reverseproxy | externa      | Nginx         | 80     |
-+--------------+--------------+---------------+--------+
-| reverseproxy | externa      | Nginx         | 443    |
-+--------------+--------------+---------------+--------+
-| reverseproxy | externa      | OpenSSH (git) | 22     |
-+--------------+--------------+---------------+--------+
-
-
-Comunicação externa
--------------------
-
-+--------------+---------------+--------+
-| Destino      | Serviço       | Porta  |
-+==============+===============+========+
-| email        | Postfix       | 25     |
-+--------------+---------------+--------+
-| reverseproxy | Nginx         | 80     |
-+--------------+---------------+--------+
-| reverseproxy | Nginx         | 443    |
-+--------------+---------------+--------+
-| reverseproxy | OpenSSH (git) | 22     |
-+--------------+---------------+--------+
-
-**Outros firewalls da rede:**
-
-Além do firewall local é importante que os serviços com origem ``externa`` tenham suas portas de INPUT abertas em todos os firewalls da rede. No caso do host ``email`` a porta **25** também deve estar aberta para OUTPUT (alternativamente o Postfix pode ser configurado para enviar e-mails utilizando um relay interno).
@@ -0,0 +1,65 @@
+Gestão do Firewall
+==================
+
+Firewall Interno
+-----------------
+
+O Portal do Software Público atualmente é composto por diversos serviços funcionando em diferentes servidores. Para o seu correto funcionamento é esperado que estes serviços se comuniquem através de TCP/IP. 
+
+Os scripts de instalação do Portal do Software Público também cuidam da manutenção das regras de firewall. Cada máquina possui um firewall (iptables) local que por padrão nega todos os tipos de conexão de entrada em todas as portas (INPUT rules) mas permite conexões de saída (OUTPUT rules).
+
+Todas as regras de firewall são definidas no cookbook ``firewall``. Para definir regras de comunidacação entre hosts locais, válidas para todos os ambientes (local, produção, homologação, testes, etc) são utilizados templates que podem ser encontrados em ``cookbooks/firewall/templates/``. Para regras de filtro utilize o arquivo ``iptables-filter.erb`` e para regras de nat o arquivo ``iptables-nat.erb``. 
+
+Para adicionar regras específicas de cada ambiente (por exemplo, abrir uma porta diferente em homologação) utilize o arquivo ``config/<nome_do_ambiente>/iptables-filter-rules``. Este arquivo aceita apenas regras de filtro do tipo INPUT.
+
+
+Comunicação Entre Serviços
+++++++++++++++++++++++++++++
+
+Os serviços que compõe o portal e suas portas de entrada são descritos na tabela a seguir:
+
++--------------+--------------+---------------+--------+
+| Destino      | Origem       + Serviço       | Porta  |
++==============+==============+===============+========+
+| database     | integration  | Redis         | 6379   |
++--------------+--------------+---------------+--------+
+| database     | integration  | PostgreSQL    | 5432   |
++--------------+--------------+---------------+--------+
+| database     | social       | PostgreSQL    | 5432   |
++--------------+--------------+---------------+--------+
+| social       | reverseproxy | Nginx         | 80     |
++--------------+--------------+---------------+--------+
+| social       | reverseproxy | Nginx         | 443    |
++--------------+--------------+---------------+--------+
+| integration  | reverseproxy | Nginx         | 80     |
++--------------+--------------+---------------+--------+
+| integration  | reverseproxy | Nginx         | 443    |
++--------------+--------------+---------------+--------+
+| email        | externa      | Postfix       | 25     |
++--------------+--------------+---------------+--------+
+| reverseproxy | externa      | Nginx         | 80     |
++--------------+--------------+---------------+--------+
+| reverseproxy | externa      | Nginx         | 443    |
++--------------+--------------+---------------+--------+
+| reverseproxy | externa      | OpenSSH (git) | 22     |
++--------------+--------------+---------------+--------+
+
+
+Comunicação externa
+-------------------
+
++--------------+---------------+--------+
+| Destino      | Serviço       | Porta  |
++==============+===============+========+
+| email        | Postfix       | 25     |
++--------------+---------------+--------+
+| reverseproxy | Nginx         | 80     |
++--------------+---------------+--------+
+| reverseproxy | Nginx         | 443    |
++--------------+---------------+--------+
+| reverseproxy | OpenSSH (git) | 22     |
++--------------+---------------+--------+
+
+**Outros firewalls da rede:**
+
+Além do firewall local é importante que os serviços com origem ``externa`` tenham suas portas de INPUT abertas em todos os firewalls da rede. No caso do host ``email`` a porta **25** também deve estar aberta para OUTPUT (alternativamente o Postfix pode ser configurado para enviar e-mails utilizando um relay interno).
@@ -0,0 +1,65 @@
+Gestão do Firewall
+==================
+
+Firewall Interno
+-----------------
+
+O Portal do Software Público atualmente é composto por diversos serviços funcionando em diferentes servidores. Para o seu correto funcionamento é esperado que estes serviços se comuniquem através de TCP/IP. 
+
+Os scripts de instalação do Portal do Software Público também cuidam da manutenção das regras de firewall. Cada máquina possui um firewall (iptables) local que por padrão nega todos os tipos de conexão de entrada em todas as portas (INPUT rules) mas permite conexões de saída (OUTPUT rules).
+
+Todas as regras de firewall são definidas no cookbook ``firewall``. Para definir regras de comunidacação entre hosts locais, válidas para todos os ambientes (local, produção, homologação, testes, etc) são utilizados templates que podem ser encontrados em ``cookbooks/firewall/templates/``. Para regras de filtro utilize o arquivo ``iptables-filter.erb`` e para regras de nat o arquivo ``iptables-nat.erb``. 
+
+Para adicionar regras específicas de cada ambiente (por exemplo, abrir uma porta diferente em homologação) utilize o arquivo ``config/<nome_do_ambiente>/iptables-filter-rules``. Este arquivo aceita apenas regras de filtro do tipo INPUT.
+
+
+Comunicação Entre Serviços
+++++++++++++++++++++++++++++
+
+Os serviços que compõe o portal e suas portas de entrada são descritos na tabela a seguir:
+
++--------------+--------------+---------------+--------+
+| Destino      | Origem       + Serviço       | Porta  |
++==============+==============+===============+========+
+| database     | integration  | Redis         | 6379   |
++--------------+--------------+---------------+--------+
+| database     | integration  | PostgreSQL    | 5432   |
++--------------+--------------+---------------+--------+
+| database     | social       | PostgreSQL    | 5432   |
++--------------+--------------+---------------+--------+
+| social       | reverseproxy | Nginx         | 80     |
++--------------+--------------+---------------+--------+
+| social       | reverseproxy | Nginx         | 443    |
++--------------+--------------+---------------+--------+
+| integration  | reverseproxy | Nginx         | 80     |
++--------------+--------------+---------------+--------+
+| integration  | reverseproxy | Nginx         | 443    |
++--------------+--------------+---------------+--------+
+| email        | externa      | Postfix       | 25     |
++--------------+--------------+---------------+--------+
+| reverseproxy | externa      | Nginx         | 80     |
++--------------+--------------+---------------+--------+
+| reverseproxy | externa      | Nginx         | 443    |
++--------------+--------------+---------------+--------+
+| reverseproxy | externa      | OpenSSH (git) | 22     |
++--------------+--------------+---------------+--------+
+
+
+Comunicação externa
+-------------------
+
++--------------+---------------+--------+
+| Destino      | Serviço       | Porta  |
++==============+===============+========+
+| email        | Postfix       | 25     |
++--------------+---------------+--------+
+| reverseproxy | Nginx         | 80     |
++--------------+---------------+--------+
+| reverseproxy | Nginx         | 443    |
++--------------+---------------+--------+
+| reverseproxy | OpenSSH (git) | 22     |
++--------------+---------------+--------+
+
+**Outros firewalls da rede:**
+
+Além do firewall local é importante que os serviços com origem ``externa`` tenham suas portas de INPUT abertas em todos os firewalls da rede. No caso do host ``email`` a porta **25** também deve estar aberta para OUTPUT (alternativamente o Postfix pode ser configurado para enviar e-mails utilizando um relay interno).
@@ -6,7 +6,9 @@ Preparação da estação de trabalho
  
 Para gerenciar o SPB, é necessária uma estação de trabalho GNU/Linux,
 que pode ser Debian 8 ou posterior, Ubuntu 14.04 ou superior, ou CentOS
-7 ou superior (e equivalentes como RHEL 7 ou superior, ou Fedora).
+7 ou superior (e equivalentes como RHEL 7 ou superior, ou Fedora).  O
+processo também pode ser feito em outros sistemas, desde que os pacotes
+equivalentes estejam instalados.
  
 As seguintes ferramentas serão necessárias:
  
@@ -138,13 +140,12 @@ repositório com o seguinte conteúdo::
  
 Isto fará com que o valor e ``SPB_ENV`` seja sempre ``@@SPB_ENV@@``, a
 não ser que você informe na linha de comando. Daqui para frente, vamos
-representar o parâmetro ``SPB_ENV=@@SPB_ENV@@`` entre ``[]`` pra lembrar
-que se ele estiver configurado no ``local.rake``, pode ser omitido.
+sempre exibir o parâmetro ``SPB_ENV=@@SPB_ENV@@``, mas lembre-se que ele pode ser omitido se você tiver configurado o *default* em ``local.rake``.
  
 Para testar a conectividade às máquinas, podemos executar um comando
 nelas::
  
-    $ rake nodes [SPB_ENV=@@SPB_ENV@@]
+    $ rake nodes SPB_ENV=@@SPB_ENV@@
     $ <PROMPT PARA VOCÊ DIGITAR>
  
 No prompt, entre um comando simples como ``sudo date``. O resultado deve ser
@@ -175,21 +176,27 @@ Uma vez configurados os parâmetros em ``config/@@SPB_ENV@@/``, podemos
 dar início à instalação. O primeiro passo é uma preconfiguração que
 precisamos fazer::
  
-    $ rake preconfig [SPB_ENV=@@SPB_ENV@@]
+    $ rake preconfig SPB_ENV=@@SPB_ENV@@
+
+
+Este comando vai fazer uma configuração inicial que é necessária para o
+resto do processo, e **só é necessária fazer uma vez**.
+
+Depois de completo o procedimento acima, para aplicar as configurações a
+todos os servidores basta executar::
  
+    $ rake converge SPB_ENV=@@SPB_ENV@@
  
-This will perform some initial configuration to the system that is required
-before doing the actual deployment.
+O comando ``converge`` na verdade é o *default*, então o seguinte é
+equivalente::
  
-After that:
+    $ rake SPB_ENV=@@SPB_ENV@@
  
-```bash
-$ rake SPB_ENV=production                   # deploys all servers
-$ rake nodes SPB_ENV=production             # lists all servers
-$ rake converge:$server SPB_ENV=production  # deploys only $server
-```
+Se você tiver configurado o ambiente **@@SPB_ENV@@** no ``local.rake``
+(ver instruções acima), então o comando seguinte, também equivalente, é
+muito mais simples::
  
-You can also do `export SPB_ENV=production` in your shell and omit it in the
-`rake` calls.
+    $ rake
  
-See the output of `rake -T` for other tasks.
+Todas as possibilidades de comandos serão listados se você executar
+``rake -T``. Consulte também a documentação do chake_.
@@ -1,12 +0,0 @@
-Software Público Brasileiro: Manual de Operação
-***********************************************
-
-.. toctree::
-   :maxdepth: 1
-
-   introducao
-   arquitetura
-   implantacao
-   manutencao
-   backup
-   firewall
@@ -0,0 +1,12 @@
+Software Público Brasileiro: Manual de Operação (@@SPB_ENV@@)
+*******************************************************************************
+
+.. toctree::
+   :maxdepth: 1
+
+   introducao
+   arquitetura
+   implantacao
+   manutencao
+   backup
+   firewall
@@ -1,55 +0,0 @@
-Introdução
-==========
-
-Bem-vindo a documentação do Portal do Software Público Brasileiro.
-
-O Portal do Software Público Brasileiro (SPB) é uma plataforma de
-compartilhamento e colaboração no desenvolvimento de softwares. O
-projeto de evolução deste portal está sendo desenvolvido pela
-Universidade de Brasília.
-
-O SPB é composto de um conjunto de ferramentas com funcionalidades
-complementares, que são desenvolvidas de forma independentes pelas suas
-respectivas comunidades. Estas ferramentas estão sendo integradas pela
-nossa equipe de forma a apresentar uma experiência de usuário
-consistente.
-
-* O Colab_ é uma ferramenta especializada na integração de outras
-  ferramentas. O Colab fornece um ponto central de autenticação de
-  usuários para as demais ferramentas da plataforma, indexa informações
-  das demais ferramentas para busca e gamificação, e fornece integração
-  visual entre as diferentes ferramentas que compõem o SOB. O Colab é um
-  software livre criado no Brasil, que teve sua origem no
-  Programa `Interlegis` do Senado Federal.
-
-.. _Colab: https://github.com/colab-community
-.. _`Programa Interlegis do Senado Federal`: http://www.interlegis.leg.br/
-
-* O Noosfero_ é uma plataforma para criação de redes sociais que conta com
-  diversas funcionalidades de gestão de conteúdo como blogs, galeria de
-  imagens e vídeos, entre outros. O Noosfero também é um software livre
-  criado no Brasil, iniciado em 2007 pela COLIVRE_ e que hoje conta com
-  uma comunidade de desenvolvimento que inclui o SERPRO, a Universidade de
-  Brasília e o Fórum Brasileiro de Economia Solidária.
-
-.. _Noosfero: http://www.noosfero.org/
-.. _COLIVRE: http://www.colivre.coop.br/
-
-* O Gitlab_ é uma plataforma para desenvolvimento colaborativo. Projetos
-  no gitlab são mantidos em repositorios ``git``, com gestão de tarefas
-  (*issue tracker*), *merge requests*, gestão de marcos (*milestones*),
-  suporte a integração com plataformas de integração contínua e
-  notificações.
-
-.. _Gitlab: https://www.gitlab.com/
-
-* O `GNU Mailman`_ é uma gerenciador de listas de email tradicionalmente
-  usado por diversas organizações no Brasil e no mundo.
-
-.. _`GNU Mailman`: http://www.gnu.org/software/mailman/
-
-O restando deste manual descreve a arquitetura do SPB bem como os
-procedimentos necessários para sua implantação, manutenção, backup e
-restauração e gestão de firewall.
-
-
@@ -0,0 +1,55 @@
+Introdução
+==========
+
+Bem-vindo a documentação do Portal do Software Público Brasileiro.
+
+O Portal do Software Público Brasileiro (SPB) é uma plataforma de
+compartilhamento e colaboração no desenvolvimento de softwares. O
+projeto de evolução deste portal está sendo desenvolvido pela
+Universidade de Brasília.
+
+O SPB é composto de um conjunto de ferramentas com funcionalidades
+complementares, que são desenvolvidas de forma independentes pelas suas
+respectivas comunidades. Estas ferramentas estão sendo integradas pela
+nossa equipe de forma a apresentar uma experiência de usuário
+consistente.
+
+* O Colab_ é uma ferramenta especializada na integração de outras
+  ferramentas. O Colab fornece um ponto central de autenticação de
+  usuários para as demais ferramentas da plataforma, indexa informações
+  das demais ferramentas para busca e gamificação, e fornece integração
+  visual entre as diferentes ferramentas que compõem o SOB. O Colab é um
+  software livre criado no Brasil, que teve sua origem no
+  Programa `Interlegis` do Senado Federal.
+
+.. _Colab: https://github.com/colab-community
+.. _`Programa Interlegis do Senado Federal`: http://www.interlegis.leg.br/
+
+* O Noosfero_ é uma plataforma para criação de redes sociais que conta com
+  diversas funcionalidades de gestão de conteúdo como blogs, galeria de
+  imagens e vídeos, entre outros. O Noosfero também é um software livre
+  criado no Brasil, iniciado em 2007 pela COLIVRE_ e que hoje conta com
+  uma comunidade de desenvolvimento que inclui o SERPRO, a Universidade de
+  Brasília e o Fórum Brasileiro de Economia Solidária.
+
+.. _Noosfero: http://www.noosfero.org/
+.. _COLIVRE: http://www.colivre.coop.br/
+
+* O Gitlab_ é uma plataforma para desenvolvimento colaborativo. Projetos
+  no gitlab são mantidos em repositorios ``git``, com gestão de tarefas
+  (*issue tracker*), *merge requests*, gestão de marcos (*milestones*),
+  suporte a integração com plataformas de integração contínua e
+  notificações.
+
+.. _Gitlab: https://www.gitlab.com/
+
+* O `GNU Mailman`_ é uma gerenciador de listas de email tradicionalmente
+  usado por diversas organizações no Brasil e no mundo.
+
+.. _`GNU Mailman`: http://www.gnu.org/software/mailman/
+
+O restando deste manual descreve a arquitetura do SPB bem como os
+procedimentos necessários para sua implantação, manutenção, backup e
+restauração e gestão de firewall.
+
+
@@ -10,8 +10,8 @@ architecture.png: architecture.dot
  
 SPB_ENV ?= local
  
-BUILT += $(patsubst %.in, %, $(wildcard *.rst.in))
-%.rst: %.rst.in build.rb
+BUILT += $(patsubst %.in, %, $(wildcard *.in))
+%: %.in build.rb
 	ruby -p build.rb $< > $@ || ($(RM) $@; false)
  
 CLEAN_FILES += $(BUILT)
@@ -1,6 +0,0 @@
-Manutenção
-==========
-
-* mantendo o sistema atualizado
-
-* modificando configurações
@@ -0,0 +1,6 @@
+Manutenção
+==========
+
+* mantendo o sistema atualizado
+
+* modificando configurações
...	...	@@ -1,18 +0,0 @@
1		-Arquitetura
2		-===========
3		-
4		-A figura a seguir representa a arquitetura do SPB.
5		-
6		-.. TODO incluir uma figura feita manualmente, a gente deve ter isso de
7		-.. apresentações anterires
8		-.. image:: architecture.png
9		-
10		-TODO:
11		-
12		-* descrever arquitetura
13		-* descrever papel de cada máquina
14		-* descrever conexões
15		-* adicionar links com o repositório de gestão de configuração
16		-
17		-* descrever repositório de gestão de configuração
18		-* descrever como o chake funciona
...	...	@@ -0,0 +1,18 @@
	1	+Arquitetura
	2	+===========
	3	+
	4	+A figura a seguir representa a arquitetura do SPB.
	5	+
	6	+.. TODO incluir uma figura feita manualmente, a gente deve ter isso de
	7	+.. apresentações anterires
	8	+.. image:: architecture.png
	9	+
	10	+TODO:
	11	+
	12	+* descrever arquitetura
	13	+* descrever papel de cada máquina
	14	+* descrever conexões
	15	+* adicionar links com o repositório de gestão de configuração
	16	+
	17	+* descrever repositório de gestão de configuração
	18	+* descrever como o chake funciona
...	...
...	...	@@ -1,331 +0,0 @@
1		-# -- coding: utf-8 --
2		-#
3		-# softwarepublico documentation build configuration file, created by
4		-# sphinx-quickstart on Thu Nov 6 15:48:07 2014.
5		-#
6		-# This file is execfile()d with the current directory set to its
7		-# containing dir.
8		-#
9		-# Note that not all possible configuration values are present in this
10		-# autogenerated file.
11		-#
12		-# All configuration values have a default; values that are commented out
13		-# serve to show the default.
14		-
15		-import sys
16		-import os
17		-
18		-# If extensions (or modules to document with autodoc) are in another directory,
19		-# add these directories to sys.path here. If the directory is relative to the
20		-# documentation root, use os.path.abspath to make it absolute, like shown here.
21		-#sys.path.insert(0, os.path.abspath('.'))
22		-
23		-# -- General configuration ------------------------------------------------
24		-
25		-# If your documentation needs a minimal Sphinx version, state it here.
26		-#needs_sphinx = '1.0'
27		-
28		-# Add any Sphinx extension module names here, as strings. They can be
29		-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
30		-# ones.
31		-extensions = []
32		-
33		-# Add any paths that contain templates here, relative to this directory.
34		-templates_path = ['_templates']
35		-
36		-# The suffix of source filenames.
37		-source_suffix = '.rst'
38		-
39		-# The encoding of source files.
40		-#source_encoding = 'utf-8-sig'
41		-
42		-# The master toctree document.
43		-master_doc = 'index'
44		-
45		-# General information about the project.
46		-project = u'softwarepublico'
47		-copyright = u'2014-2015, Universidade de Brasília - UnB. Documentação licenciada sob a Licença Creative Commons Atribuição-CompartilhaIgual 4.0 Internacional'
48		-
49		-# The version info for the project you're documenting, acts as replacement for
50		-# \|version\| and \|release\|, also used in various other places throughout the
51		-# built documents.
52		-#
53		-# The short X.Y version.
54		-version = '2.0'
55		-# The full version, including alpha/beta/rc tags.
56		-release = '2.0'
57		-
58		-# The language for content autogenerated by Sphinx. Refer to documentation
59		-# for a list of supported languages.
60		-language = 'pt_BR'
61		-
62		-# There are two options for replacing \|today\|: either, you set today to some
63		-# non-false value, then it is used:
64		-#today = ''
65		-# Else, today_fmt is used as the format for a strftime call.
66		-#today_fmt = '%B %d, %Y'
67		-
68		-# List of patterns, relative to source directory, that match files and
69		-# directories to ignore when looking for source files.
70		-exclude_patterns = ['_build']
71		-
72		-# The reST default role (used for this markup: `text`) to use for all
73		-# documents.
74		-#default_role = None
75		-
76		-# If true, '()' will be appended to :func: etc. cross-reference text.
77		-#add_function_parentheses = True
78		-
79		-# If true, the current module name will be prepended to all description
80		-# unit titles (such as .. function::).
81		-#add_module_names = True
82		-
83		-# If true, sectionauthor and moduleauthor directives will be shown in the
84		-# output. They are ignored by default.
85		-#show_authors = False
86		-
87		-# The name of the Pygments (syntax highlighting) style to use.
88		-pygments_style = 'sphinx'
89		-
90		-# A list of ignored prefixes for module index sorting.
91		-#modindex_common_prefix = []
92		-
93		-# If true, keep warnings as "system message" paragraphs in the built documents.
94		-#keep_warnings = False
95		-
96		-
97		-# -- Options for HTML output ----------------------------------------------
98		-
99		-# The theme to use for HTML and HTML Help pages. See the documentation for
100		-# a list of builtin themes.
101		-html_theme = 'default'
102		-
103		-# Theme options are theme-specific and customize the look and feel of a theme
104		-# further. For a list of options available for each theme, see the
105		-# documentation.
106		-#html_theme_options = {}
107		-
108		-# Add any paths that contain custom themes here, relative to this directory.
109		-#html_theme_path = []
110		-
111		-# The name for this set of Sphinx documents. If None, it defaults to
112		-# "<project> v<release> documentation".
113		-#html_title = None
114		-
115		-# A shorter title for the navigation bar. Default is the same as html_title.
116		-#html_short_title = None
117		-
118		-# The name of an image file (relative to this directory) to place at the top
119		-# of the sidebar.
120		-#html_logo = None
121		-
122		-# The name of an image file (within the static path) to use as favicon of the
123		-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
124		-# pixels large.
125		-#html_favicon = None
126		-
127		-# Add any paths that contain custom static files (such as style sheets) here,
128		-# relative to this directory. They are copied after the builtin static files,
129		-# so a file named "default.css" will overwrite the builtin "default.css".
130		-html_static_path = ['_static']
131		-
132		-# Add any extra paths that contain custom files (such as robots.txt or
133		-# .htaccess) here, relative to this directory. These files are copied
134		-# directly to the root of the documentation.
135		-#html_extra_path = []
136		-
137		-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
138		-# using the given strftime format.
139		-#html_last_updated_fmt = '%b %d, %Y'
140		-
141		-# If true, SmartyPants will be used to convert quotes and dashes to
142		-# typographically correct entities.
143		-#html_use_smartypants = True
144		-
145		-# Custom sidebar templates, maps document names to template names.
146		-#html_sidebars = {}
147		-
148		-# Additional templates that should be rendered to pages, maps page names to
149		-# template names.
150		-#html_additional_pages = {}
151		-
152		-# If false, no module index is generated.
153		-#html_domain_indices = True
154		-
155		-# If false, no index is generated.
156		-#html_use_index = True
157		-
158		-# If true, the index is split into individual pages for each letter.
159		-#html_split_index = False
160		-
161		-# If true, links to the reST sources are added to the pages.
162		-#html_show_sourcelink = True
163		-
164		-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
165		-#html_show_sphinx = True
166		-
167		-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
168		-#html_show_copyright = True
169		-
170		-# If true, an OpenSearch description file will be output, and all pages will
171		-# contain a <link> tag referring to it. The value of this option must be the
172		-# base URL from which the finished HTML is served.
173		-#html_use_opensearch = ''
174		-
175		-# This is the file name suffix for HTML files (e.g. ".xhtml").
176		-#html_file_suffix = None
177		-
178		-# Output file base name for HTML help builder.
179		-htmlhelp_basename = 'softwarepublicodoc'
180		-
181		-
182		-# -- Options for LaTeX output ---------------------------------------------
183		-
184		-latex_elements = {
185		-# The paper size ('letterpaper' or 'a4paper').
186		-#'papersize': 'letterpaper',
187		-
188		-# The font size ('10pt', '11pt' or '12pt').
189		-#'pointsize': '10pt',
190		-
191		-# Additional stuff for the LaTeX preamble.
192		-#'preamble': '',
193		-}
194		-
195		-# Grouping the document tree into LaTeX files. List of tuples
196		-# (source start file, target name, title,
197		-# author, documentclass [howto, manual, or own class]).
198		-latex_documents = [
199		- ('index', 'softwarepublico.tex',
200		- u'Software Público Brasileiro: Manual de Operação',
201		- u'Universidade de Brasília', 'manual'),
202		-]
203		-
204		-# The name of an image file (relative to this directory) to place at the top of
205		-# the title page.
206		-#latex_logo = None
207		-
208		-# For "manual" documents, if this is true, then toplevel headings are parts,
209		-# not chapters.
210		-#latex_use_parts = False
211		-
212		-# If true, show page references after internal links.
213		-#latex_show_pagerefs = False
214		-
215		-# If true, show URL addresses after external links.
216		-#latex_show_urls = False
217		-
218		-# Documents to append as an appendix to all manuals.
219		-#latex_appendices = []
220		-
221		-# If false, no module index is generated.
222		-#latex_domain_indices = True
223		-
224		-
225		-# -- Options for manual page output ---------------------------------------
226		-
227		-# One entry per manual page. List of tuples
228		-# (source start file, name, description, authors, manual section).
229		-man_pages = [
230		- ('index', 'softwarepublico',
231		- u'Documentação - Software Público Brasileiro (SPB)',
232		- [u'Universidade de Brasília'], 1)
233		-]
234		-
235		-# If true, show URL addresses after external links.
236		-#man_show_urls = False
237		-
238		-
239		-# -- Options for Texinfo output -------------------------------------------
240		-
241		-# Grouping the document tree into Texinfo files. List of tuples
242		-# (source start file, target name, title, author,
243		-# dir menu entry, description, category)
244		-texinfo_documents = [
245		- ('index', 'softwarepublico',
246		- u'Documentação - Software Público Brasileiro (SPB)',
247		- u'Universidade de Brasília', 'softwarepublico', 'One line description of project.',
248		- 'Miscellaneous'),
249		-]
250		-
251		-# Documents to append as an appendix to all manuals.
252		-#texinfo_appendices = []
253		-
254		-# If false, no module index is generated.
255		-#texinfo_domain_indices = True
256		-
257		-# How to display URL addresses: 'footnote', 'no', or 'inline'.
258		-#texinfo_show_urls = 'footnote'
259		-
260		-# If true, do not generate a @detailmenu in the "Top" node's menu.
261		-#texinfo_no_detailmenu = False
262		-
263		-
264		-# -- Options for Epub output ----------------------------------------------
265		-
266		-# Bibliographic Dublin Core info.
267		-epub_title = u'softwarepublico'
268		-epub_author = u'Universidade de Brasília'
269		-epub_publisher = u'Universidade de Brasília'
270		-epub_copyright = u'2014, Universidade de Brasília. Documentação licenciada sob a Licença Crea tive Commons Atribuição-CompartilhaIgual 4.0 Internacional'
271		-
272		-# The basename for the epub file. It defaults to the project name.
273		-#epub_basename = u'softwarepublico'
274		-
275		-# The HTML theme for the epub output. Since the default themes are not optimized
276		-# for small screen space, using the same theme for HTML and epub output is
277		-# usually not wise. This defaults to 'epub', a theme designed to save visual
278		-# space.
279		-#epub_theme = 'epub'
280		-
281		-# The language of the text. It defaults to the language option
282		-# or en if the language is not set.
283		-#epub_language = ''
284		-
285		-# The scheme of the identifier. Typical schemes are ISBN or URL.
286		-#epub_scheme = ''
287		-
288		-# The unique identifier of the text. This can be a ISBN number
289		-# or the project homepage.
290		-#epub_identifier = ''
291		-
292		-# A unique identification for the text.
293		-#epub_uid = ''
294		-
295		-# A tuple containing the cover image and cover page html template filenames.
296		-#epub_cover = ()
297		-
298		-# A sequence of (type, uri, title) tuples for the guide element of content.opf.
299		-#epub_guide = ()
300		-
301		-# HTML files that should be inserted before the pages created by sphinx.
302		-# The format is a list of tuples containing the path and title.
303		-#epub_pre_files = []
304		-
305		-# HTML files shat should be inserted after the pages created by sphinx.
306		-# The format is a list of tuples containing the path and title.
307		-#epub_post_files = []
308		-
309		-# A list of files that should not be packed into the epub file.
310		-epub_exclude_files = ['search.html']
311		-
312		-# The depth of the table of contents in toc.ncx.
313		-#epub_tocdepth = 3
314		-
315		-# Allow duplicate toc entries.
316		-#epub_tocdup = True
317		-
318		-# Choose between 'default' and 'includehidden'.
319		-#epub_tocscope = 'default'
320		-
321		-# Fix unsupported image types using the PIL.
322		-#epub_fix_images = False
323		-
324		-# Scale large images.
325		-#epub_max_image_width = 0
326		-
327		-# How to display URL addresses: 'footnote', 'no', or 'inline'.
328		-#epub_show_urls = 'inline'
329		-
330		-# If false, no index is generated.
331		-#epub_use_index = True
...	...	@@ -0,0 +1,331 @@
	1	+# -- coding: utf-8 --
	2	+#
	3	+# softwarepublico documentation build configuration file, created by
	4	+# sphinx-quickstart on Thu Nov 6 15:48:07 2014.
	5	+#
	6	+# This file is execfile()d with the current directory set to its
	7	+# containing dir.
	8	+#
	9	+# Note that not all possible configuration values are present in this
	10	+# autogenerated file.
	11	+#
	12	+# All configuration values have a default; values that are commented out
	13	+# serve to show the default.
	14	+
	15	+import sys
	16	+import os
	17	+
	18	+# If extensions (or modules to document with autodoc) are in another directory,
	19	+# add these directories to sys.path here. If the directory is relative to the
	20	+# documentation root, use os.path.abspath to make it absolute, like shown here.
	21	+#sys.path.insert(0, os.path.abspath('.'))
	22	+
	23	+# -- General configuration ------------------------------------------------
	24	+
	25	+# If your documentation needs a minimal Sphinx version, state it here.
	26	+#needs_sphinx = '1.0'
	27	+
	28	+# Add any Sphinx extension module names here, as strings. They can be
	29	+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
	30	+# ones.
	31	+extensions = []
	32	+
	33	+# Add any paths that contain templates here, relative to this directory.
	34	+templates_path = ['_templates']
	35	+
	36	+# The suffix of source filenames.
	37	+source_suffix = '.rst'
	38	+
	39	+# The encoding of source files.
	40	+#source_encoding = 'utf-8-sig'
	41	+
	42	+# The master toctree document.
	43	+master_doc = 'index'
	44	+
	45	+# General information about the project.
	46	+project = u'softwarepublico'
	47	+copyright = u'2014-2015, Universidade de Brasília - UnB. Documentação licenciada sob a Licença Creative Commons Atribuição-CompartilhaIgual 4.0 Internacional'
	48	+
	49	+# The version info for the project you're documenting, acts as replacement for
	50	+# \|version\| and \|release\|, also used in various other places throughout the
	51	+# built documents.
	52	+#
	53	+# The short X.Y version.
	54	+version = '2.0'
	55	+# The full version, including alpha/beta/rc tags.
	56	+release = '2.0'
	57	+
	58	+# The language for content autogenerated by Sphinx. Refer to documentation
	59	+# for a list of supported languages.
	60	+language = 'pt_BR'
	61	+
	62	+# There are two options for replacing \|today\|: either, you set today to some
	63	+# non-false value, then it is used:
	64	+#today = ''
	65	+# Else, today_fmt is used as the format for a strftime call.
	66	+#today_fmt = '%B %d, %Y'
	67	+
	68	+# List of patterns, relative to source directory, that match files and
	69	+# directories to ignore when looking for source files.
	70	+exclude_patterns = ['_build']
	71	+
	72	+# The reST default role (used for this markup: `text`) to use for all
	73	+# documents.
	74	+#default_role = None
	75	+
	76	+# If true, '()' will be appended to :func: etc. cross-reference text.
	77	+#add_function_parentheses = True
	78	+
	79	+# If true, the current module name will be prepended to all description
	80	+# unit titles (such as .. function::).
	81	+#add_module_names = True
	82	+
	83	+# If true, sectionauthor and moduleauthor directives will be shown in the
	84	+# output. They are ignored by default.
	85	+#show_authors = False
	86	+
	87	+# The name of the Pygments (syntax highlighting) style to use.
	88	+pygments_style = 'sphinx'
	89	+
	90	+# A list of ignored prefixes for module index sorting.
	91	+#modindex_common_prefix = []
	92	+
	93	+# If true, keep warnings as "system message" paragraphs in the built documents.
	94	+#keep_warnings = False
	95	+
	96	+
	97	+# -- Options for HTML output ----------------------------------------------
	98	+
	99	+# The theme to use for HTML and HTML Help pages. See the documentation for
	100	+# a list of builtin themes.
	101	+html_theme = 'default'
	102	+
	103	+# Theme options are theme-specific and customize the look and feel of a theme
	104	+# further. For a list of options available for each theme, see the
	105	+# documentation.
	106	+#html_theme_options = {}
	107	+
	108	+# Add any paths that contain custom themes here, relative to this directory.
	109	+#html_theme_path = []
	110	+
	111	+# The name for this set of Sphinx documents. If None, it defaults to
	112	+# "<project> v<release> documentation".
	113	+#html_title = None
	114	+
	115	+# A shorter title for the navigation bar. Default is the same as html_title.
	116	+#html_short_title = None
	117	+
	118	+# The name of an image file (relative to this directory) to place at the top
	119	+# of the sidebar.
	120	+#html_logo = None
	121	+
	122	+# The name of an image file (within the static path) to use as favicon of the
	123	+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
	124	+# pixels large.
	125	+#html_favicon = None
	126	+
	127	+# Add any paths that contain custom static files (such as style sheets) here,
	128	+# relative to this directory. They are copied after the builtin static files,
	129	+# so a file named "default.css" will overwrite the builtin "default.css".
	130	+html_static_path = ['_static']
	131	+
	132	+# Add any extra paths that contain custom files (such as robots.txt or
	133	+# .htaccess) here, relative to this directory. These files are copied
	134	+# directly to the root of the documentation.
	135	+#html_extra_path = []
	136	+
	137	+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
	138	+# using the given strftime format.
	139	+#html_last_updated_fmt = '%b %d, %Y'
	140	+
	141	+# If true, SmartyPants will be used to convert quotes and dashes to
	142	+# typographically correct entities.
	143	+#html_use_smartypants = True
	144	+
	145	+# Custom sidebar templates, maps document names to template names.
	146	+#html_sidebars = {}
	147	+
	148	+# Additional templates that should be rendered to pages, maps page names to
	149	+# template names.
	150	+#html_additional_pages = {}
	151	+
	152	+# If false, no module index is generated.
	153	+#html_domain_indices = True
	154	+
	155	+# If false, no index is generated.
	156	+#html_use_index = True
	157	+
	158	+# If true, the index is split into individual pages for each letter.
	159	+#html_split_index = False
	160	+
	161	+# If true, links to the reST sources are added to the pages.
	162	+#html_show_sourcelink = True
	163	+
	164	+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
	165	+#html_show_sphinx = True
	166	+
	167	+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
	168	+#html_show_copyright = True
	169	+
	170	+# If true, an OpenSearch description file will be output, and all pages will
	171	+# contain a <link> tag referring to it. The value of this option must be the
	172	+# base URL from which the finished HTML is served.
	173	+#html_use_opensearch = ''
	174	+
	175	+# This is the file name suffix for HTML files (e.g. ".xhtml").
	176	+#html_file_suffix = None
	177	+
	178	+# Output file base name for HTML help builder.
	179	+htmlhelp_basename = 'softwarepublicodoc'
	180	+
	181	+
	182	+# -- Options for LaTeX output ---------------------------------------------
	183	+
	184	+latex_elements = {
	185	+# The paper size ('letterpaper' or 'a4paper').
	186	+#'papersize': 'letterpaper',
	187	+
	188	+# The font size ('10pt', '11pt' or '12pt').
	189	+#'pointsize': '10pt',
	190	+
	191	+# Additional stuff for the LaTeX preamble.
	192	+#'preamble': '',
	193	+}
	194	+
	195	+# Grouping the document tree into LaTeX files. List of tuples
	196	+# (source start file, target name, title,
	197	+# author, documentclass [howto, manual, or own class]).
	198	+latex_documents = [
	199	+ ('index', 'softwarepublico.tex',
	200	+ u'Software Público Brasileiro: Manual de Operação (@@SPB_ENV@@)',
	201	+ u'Universidade de Brasília', 'manual'),
	202	+]
	203	+
	204	+# The name of an image file (relative to this directory) to place at the top of
	205	+# the title page.
	206	+#latex_logo = None
	207	+
	208	+# For "manual" documents, if this is true, then toplevel headings are parts,
	209	+# not chapters.
	210	+#latex_use_parts = False
	211	+
	212	+# If true, show page references after internal links.
	213	+#latex_show_pagerefs = False
	214	+
	215	+# If true, show URL addresses after external links.
	216	+#latex_show_urls = False
	217	+
	218	+# Documents to append as an appendix to all manuals.
	219	+#latex_appendices = []
	220	+
	221	+# If false, no module index is generated.
	222	+#latex_domain_indices = True
	223	+
	224	+
	225	+# -- Options for manual page output ---------------------------------------
	226	+
	227	+# One entry per manual page. List of tuples
	228	+# (source start file, name, description, authors, manual section).
	229	+man_pages = [
	230	+ ('index', 'softwarepublico',
	231	+ u'Documentação - Software Público Brasileiro (SPB)',
	232	+ [u'Universidade de Brasília'], 1)
	233	+]
	234	+
	235	+# If true, show URL addresses after external links.
	236	+#man_show_urls = False
	237	+
	238	+
	239	+# -- Options for Texinfo output -------------------------------------------
	240	+
	241	+# Grouping the document tree into Texinfo files. List of tuples
	242	+# (source start file, target name, title, author,
	243	+# dir menu entry, description, category)
	244	+texinfo_documents = [
	245	+ ('index', 'softwarepublico',
	246	+ u'Documentação - Software Público Brasileiro (SPB)',
	247	+ u'Universidade de Brasília', 'softwarepublico', 'One line description of project.',
	248	+ 'Miscellaneous'),
	249	+]
	250	+
	251	+# Documents to append as an appendix to all manuals.
	252	+#texinfo_appendices = []
	253	+
	254	+# If false, no module index is generated.
	255	+#texinfo_domain_indices = True
	256	+
	257	+# How to display URL addresses: 'footnote', 'no', or 'inline'.
	258	+#texinfo_show_urls = 'footnote'
	259	+
	260	+# If true, do not generate a @detailmenu in the "Top" node's menu.
	261	+#texinfo_no_detailmenu = False
	262	+
	263	+
	264	+# -- Options for Epub output ----------------------------------------------
	265	+
	266	+# Bibliographic Dublin Core info.
	267	+epub_title = u'softwarepublico'
	268	+epub_author = u'Universidade de Brasília'
	269	+epub_publisher = u'Universidade de Brasília'
	270	+epub_copyright = u'2014, Universidade de Brasília. Documentação licenciada sob a Licença Crea tive Commons Atribuição-CompartilhaIgual 4.0 Internacional'
	271	+
	272	+# The basename for the epub file. It defaults to the project name.
	273	+#epub_basename = u'softwarepublico'
	274	+
	275	+# The HTML theme for the epub output. Since the default themes are not optimized
	276	+# for small screen space, using the same theme for HTML and epub output is
	277	+# usually not wise. This defaults to 'epub', a theme designed to save visual
	278	+# space.
	279	+#epub_theme = 'epub'
	280	+
	281	+# The language of the text. It defaults to the language option
	282	+# or en if the language is not set.
	283	+#epub_language = ''
	284	+
	285	+# The scheme of the identifier. Typical schemes are ISBN or URL.
	286	+#epub_scheme = ''
	287	+
	288	+# The unique identifier of the text. This can be a ISBN number
	289	+# or the project homepage.
	290	+#epub_identifier = ''
	291	+
	292	+# A unique identification for the text.
	293	+#epub_uid = ''
	294	+
	295	+# A tuple containing the cover image and cover page html template filenames.
	296	+#epub_cover = ()
	297	+
	298	+# A sequence of (type, uri, title) tuples for the guide element of content.opf.
	299	+#epub_guide = ()
	300	+
	301	+# HTML files that should be inserted before the pages created by sphinx.
	302	+# The format is a list of tuples containing the path and title.
	303	+#epub_pre_files = []
	304	+
	305	+# HTML files shat should be inserted after the pages created by sphinx.
	306	+# The format is a list of tuples containing the path and title.
	307	+#epub_post_files = []
	308	+
	309	+# A list of files that should not be packed into the epub file.
	310	+epub_exclude_files = ['search.html']
	311	+
	312	+# The depth of the table of contents in toc.ncx.
	313	+#epub_tocdepth = 3
	314	+
	315	+# Allow duplicate toc entries.
	316	+#epub_tocdup = True
	317	+
	318	+# Choose between 'default' and 'includehidden'.
	319	+#epub_tocscope = 'default'
	320	+
	321	+# Fix unsupported image types using the PIL.
	322	+#epub_fix_images = False
	323	+
	324	+# Scale large images.
	325	+#epub_max_image_width = 0
	326	+
	327	+# How to display URL addresses: 'footnote', 'no', or 'inline'.
	328	+#epub_show_urls = 'inline'
	329	+
	330	+# If false, no index is generated.
	331	+#epub_use_index = True
...	...
...	...	@@ -1,65 +0,0 @@
1		-Gestão do Firewall
2		-==================
3		-
4		-Firewall Interno
5		------------------
6		-
7		-O Portal do Software Público atualmente é composto por diversos serviços funcionando em diferentes servidores. Para o seu correto funcionamento é esperado que estes serviços se comuniquem através de TCP/IP.
8		-
9		-Os scripts de instalação do Portal do Software Público também cuidam da manutenção das regras de firewall. Cada máquina possui um firewall (iptables) local que por padrão nega todos os tipos de conexão de entrada em todas as portas (INPUT rules) mas permite conexões de saída (OUTPUT rules).
10		-
11		-Todas as regras de firewall são definidas no cookbook ``firewall``. Para definir regras de comunidacação entre hosts locais, válidas para todos os ambientes (local, produção, homologação, testes, etc) são utilizados templates que podem ser encontrados em ``cookbooks/firewall/templates/``. Para regras de filtro utilize o arquivo ``iptables-filter.erb`` e para regras de nat o arquivo ``iptables-nat.erb``.
12		-
13		-Para adicionar regras específicas de cada ambiente (por exemplo, abrir uma porta diferente em homologação) utilize o arquivo ``config/<nome_do_ambiente>/iptables-filter-rules``. Este arquivo aceita apenas regras de filtro do tipo INPUT.
14		-
15		-
16		-Comunicação Entre Serviços
17		-++++++++++++++++++++++++++++
18		-
19		-Os serviços que compõe o portal e suas portas de entrada são descritos na tabela a seguir:
20		-
21		-+--------------+--------------+---------------+--------+
22		-\| Destino \| Origem + Serviço \| Porta \|
23		-+==============+==============+===============+========+
24		-\| database \| integration \| Redis \| 6379 \|
25		-+--------------+--------------+---------------+--------+
26		-\| database \| integration \| PostgreSQL \| 5432 \|
27		-+--------------+--------------+---------------+--------+
28		-\| database \| social \| PostgreSQL \| 5432 \|
29		-+--------------+--------------+---------------+--------+
30		-\| social \| reverseproxy \| Nginx \| 80 \|
31		-+--------------+--------------+---------------+--------+
32		-\| social \| reverseproxy \| Nginx \| 443 \|
33		-+--------------+--------------+---------------+--------+
34		-\| integration \| reverseproxy \| Nginx \| 80 \|
35		-+--------------+--------------+---------------+--------+
36		-\| integration \| reverseproxy \| Nginx \| 443 \|
37		-+--------------+--------------+---------------+--------+
38		-\| email \| externa \| Postfix \| 25 \|
39		-+--------------+--------------+---------------+--------+
40		-\| reverseproxy \| externa \| Nginx \| 80 \|
41		-+--------------+--------------+---------------+--------+
42		-\| reverseproxy \| externa \| Nginx \| 443 \|
43		-+--------------+--------------+---------------+--------+
44		-\| reverseproxy \| externa \| OpenSSH (git) \| 22 \|
45		-+--------------+--------------+---------------+--------+
46		-
47		-
48		-Comunicação externa
49		--------------------
50		-
51		-+--------------+---------------+--------+
52		-\| Destino \| Serviço \| Porta \|
53		-+==============+===============+========+
54		-\| email \| Postfix \| 25 \|
55		-+--------------+---------------+--------+
56		-\| reverseproxy \| Nginx \| 80 \|
57		-+--------------+---------------+--------+
58		-\| reverseproxy \| Nginx \| 443 \|
59		-+--------------+---------------+--------+
60		-\| reverseproxy \| OpenSSH (git) \| 22 \|
61		-+--------------+---------------+--------+
62		-
63		-Outros firewalls da rede:
64		-
65		-Além do firewall local é importante que os serviços com origem ``externa`` tenham suas portas de INPUT abertas em todos os firewalls da rede. No caso do host ``email`` a porta 25 também deve estar aberta para OUTPUT (alternativamente o Postfix pode ser configurado para enviar e-mails utilizando um relay interno).
...	...	@@ -0,0 +1,65 @@
	1	+Gestão do Firewall
	2	+==================
	3	+
	4	+Firewall Interno
	5	+-----------------
	6	+
	7	+O Portal do Software Público atualmente é composto por diversos serviços funcionando em diferentes servidores. Para o seu correto funcionamento é esperado que estes serviços se comuniquem através de TCP/IP.
	8	+
	9	+Os scripts de instalação do Portal do Software Público também cuidam da manutenção das regras de firewall. Cada máquina possui um firewall (iptables) local que por padrão nega todos os tipos de conexão de entrada em todas as portas (INPUT rules) mas permite conexões de saída (OUTPUT rules).
	10	+
	11	+Todas as regras de firewall são definidas no cookbook ``firewall``. Para definir regras de comunidacação entre hosts locais, válidas para todos os ambientes (local, produção, homologação, testes, etc) são utilizados templates que podem ser encontrados em ``cookbooks/firewall/templates/``. Para regras de filtro utilize o arquivo ``iptables-filter.erb`` e para regras de nat o arquivo ``iptables-nat.erb``.
	12	+
	13	+Para adicionar regras específicas de cada ambiente (por exemplo, abrir uma porta diferente em homologação) utilize o arquivo ``config/<nome_do_ambiente>/iptables-filter-rules``. Este arquivo aceita apenas regras de filtro do tipo INPUT.
	14	+
	15	+
	16	+Comunicação Entre Serviços
	17	+++++++++++++++++++++++++++++
	18	+
	19	+Os serviços que compõe o portal e suas portas de entrada são descritos na tabela a seguir:
	20	+
	21	++--------------+--------------+---------------+--------+
	22	+\| Destino \| Origem + Serviço \| Porta \|
	23	++==============+==============+===============+========+
	24	+\| database \| integration \| Redis \| 6379 \|
	25	++--------------+--------------+---------------+--------+
	26	+\| database \| integration \| PostgreSQL \| 5432 \|
	27	++--------------+--------------+---------------+--------+
	28	+\| database \| social \| PostgreSQL \| 5432 \|
	29	++--------------+--------------+---------------+--------+
	30	+\| social \| reverseproxy \| Nginx \| 80 \|
	31	++--------------+--------------+---------------+--------+
	32	+\| social \| reverseproxy \| Nginx \| 443 \|
	33	++--------------+--------------+---------------+--------+
	34	+\| integration \| reverseproxy \| Nginx \| 80 \|
	35	++--------------+--------------+---------------+--------+
	36	+\| integration \| reverseproxy \| Nginx \| 443 \|
	37	++--------------+--------------+---------------+--------+
	38	+\| email \| externa \| Postfix \| 25 \|
	39	++--------------+--------------+---------------+--------+
	40	+\| reverseproxy \| externa \| Nginx \| 80 \|
	41	++--------------+--------------+---------------+--------+
	42	+\| reverseproxy \| externa \| Nginx \| 443 \|
	43	++--------------+--------------+---------------+--------+
	44	+\| reverseproxy \| externa \| OpenSSH (git) \| 22 \|
	45	++--------------+--------------+---------------+--------+
	46	+
	47	+
	48	+Comunicação externa
	49	+-------------------
	50	+
	51	++--------------+---------------+--------+
	52	+\| Destino \| Serviço \| Porta \|
	53	++==============+===============+========+
	54	+\| email \| Postfix \| 25 \|
	55	++--------------+---------------+--------+
	56	+\| reverseproxy \| Nginx \| 80 \|
	57	++--------------+---------------+--------+
	58	+\| reverseproxy \| Nginx \| 443 \|
	59	++--------------+---------------+--------+
	60	+\| reverseproxy \| OpenSSH (git) \| 22 \|
	61	++--------------+---------------+--------+
	62	+
	63	+Outros firewalls da rede:
	64	+
	65	+Além do firewall local é importante que os serviços com origem ``externa`` tenham suas portas de INPUT abertas em todos os firewalls da rede. No caso do host ``email`` a porta 25 também deve estar aberta para OUTPUT (alternativamente o Postfix pode ser configurado para enviar e-mails utilizando um relay interno).
...	...
...	...	@@ -6,7 +6,9 @@ Preparação da estação de trabalho
6	6
7	7	Para gerenciar o SPB, é necessária uma estação de trabalho GNU/Linux,
8	8	que pode ser Debian 8 ou posterior, Ubuntu 14.04 ou superior, ou CentOS
9		-7 ou superior (e equivalentes como RHEL 7 ou superior, ou Fedora).
	9	+7 ou superior (e equivalentes como RHEL 7 ou superior, ou Fedora). O
	10	+processo também pode ser feito em outros sistemas, desde que os pacotes
	11	+equivalentes estejam instalados.
10	12
11	13	As seguintes ferramentas serão necessárias:
12	14
...	...	@@ -138,13 +140,12 @@ repositório com o seguinte conteúdo::
138	140
139	141	Isto fará com que o valor e ``SPB_ENV`` seja sempre ``@@SPB_ENV@@``, a
140	142	não ser que você informe na linha de comando. Daqui para frente, vamos
141		-representar o parâmetro ``SPB_ENV=@@SPB_ENV@@`` entre ``[]`` pra lembrar
142		-que se ele estiver configurado no ``local.rake``, pode ser omitido.
	143	+sempre exibir o parâmetro ``SPB_ENV=@@SPB_ENV@@``, mas lembre-se que ele pode ser omitido se você tiver configurado o default em ``local.rake``.
143	144
144	145	Para testar a conectividade às máquinas, podemos executar um comando
145	146	nelas::
146	147
147		- $ rake nodes [SPB_ENV=@@SPB_ENV@@]
	148	+ $ rake nodes SPB_ENV=@@SPB_ENV@@
148	149	$ <PROMPT PARA VOCÊ DIGITAR>
149	150
150	151	No prompt, entre um comando simples como ``sudo date``. O resultado deve ser
...	...	@@ -175,21 +176,27 @@ Uma vez configurados os parâmetros em ``config/@@SPB_ENV@@/``, podemos
175	176	dar início à instalação. O primeiro passo é uma preconfiguração que
176	177	precisamos fazer::
177	178
178		- $ rake preconfig [SPB_ENV=@@SPB_ENV@@]
	179	+ $ rake preconfig SPB_ENV=@@SPB_ENV@@
	180	+
	181	+
	182	+Este comando vai fazer uma configuração inicial que é necessária para o
	183	+resto do processo, e só é necessária fazer uma vez.
	184	+
	185	+Depois de completo o procedimento acima, para aplicar as configurações a
	186	+todos os servidores basta executar::
179	187
	188	+ $ rake converge SPB_ENV=@@SPB_ENV@@
180	189
181		-This will perform some initial configuration to the system that is required
182		-before doing the actual deployment.
	190	+O comando ``converge`` na verdade é o default, então o seguinte é
	191	+equivalente::
183	192
184		-After that:
	193	+ $ rake SPB_ENV=@@SPB_ENV@@
185	194
186		-```bash
187		-$ rake SPB_ENV=production # deploys all servers
188		-$ rake nodes SPB_ENV=production # lists all servers
189		-$ rake converge:$server SPB_ENV=production # deploys only $server
190		-```
	195	+Se você tiver configurado o ambiente @@SPB_ENV@@ no ``local.rake``
	196	+(ver instruções acima), então o comando seguinte, também equivalente, é
	197	+muito mais simples::
191	198
192		-You can also do `export SPB_ENV=production` in your shell and omit it in the
193		-`rake` calls.
	199	+ $ rake
194	200
195		-See the output of `rake -T` for other tasks.
	201	+Todas as possibilidades de comandos serão listados se você executar
	202	+``rake -T``. Consulte também a documentação do chake_.
...	...
...	...	@@ -1,12 +0,0 @@
1		-Software Público Brasileiro: Manual de Operação
2		-***********************************************
3		-
4		-.. toctree::
5		- :maxdepth: 1
6		-
7		- introducao
8		- arquitetura
9		- implantacao
10		- manutencao
11		- backup
12		- firewall
...	...	@@ -0,0 +1,12 @@
	1	+Software Público Brasileiro: Manual de Operação (@@SPB_ENV@@)
	2	+*******************************************************************************
	3	+
	4	+.. toctree::
	5	+ :maxdepth: 1
	6	+
	7	+ introducao
	8	+ arquitetura
	9	+ implantacao
	10	+ manutencao
	11	+ backup
	12	+ firewall
...	...
...	...	@@ -1,55 +0,0 @@
1		-Introdução
2		-==========
3		-
4		-Bem-vindo a documentação do Portal do Software Público Brasileiro.
5		-
6		-O Portal do Software Público Brasileiro (SPB) é uma plataforma de
7		-compartilhamento e colaboração no desenvolvimento de softwares. O
8		-projeto de evolução deste portal está sendo desenvolvido pela
9		-Universidade de Brasília.
10		-
11		-O SPB é composto de um conjunto de ferramentas com funcionalidades
12		-complementares, que são desenvolvidas de forma independentes pelas suas
13		-respectivas comunidades. Estas ferramentas estão sendo integradas pela
14		-nossa equipe de forma a apresentar uma experiência de usuário
15		-consistente.
16		-
17		-* O Colab_ é uma ferramenta especializada na integração de outras
18		- ferramentas. O Colab fornece um ponto central de autenticação de
19		- usuários para as demais ferramentas da plataforma, indexa informações
20		- das demais ferramentas para busca e gamificação, e fornece integração
21		- visual entre as diferentes ferramentas que compõem o SOB. O Colab é um
22		- software livre criado no Brasil, que teve sua origem no
23		- Programa `Interlegis` do Senado Federal.
24		-
25		-.. _Colab: https://github.com/colab-community
26		-.. _`Programa Interlegis do Senado Federal`: http://www.interlegis.leg.br/
27		-
28		-* O Noosfero_ é uma plataforma para criação de redes sociais que conta com
29		- diversas funcionalidades de gestão de conteúdo como blogs, galeria de
30		- imagens e vídeos, entre outros. O Noosfero também é um software livre
31		- criado no Brasil, iniciado em 2007 pela COLIVRE_ e que hoje conta com
32		- uma comunidade de desenvolvimento que inclui o SERPRO, a Universidade de
33		- Brasília e o Fórum Brasileiro de Economia Solidária.
34		-
35		-.. _Noosfero: http://www.noosfero.org/
36		-.. _COLIVRE: http://www.colivre.coop.br/
37		-
38		-* O Gitlab_ é uma plataforma para desenvolvimento colaborativo. Projetos
39		- no gitlab são mantidos em repositorios ``git``, com gestão de tarefas
40		- (issue tracker), merge requests, gestão de marcos (milestones),
41		- suporte a integração com plataformas de integração contínua e
42		- notificações.
43		-
44		-.. _Gitlab: https://www.gitlab.com/
45		-
46		-* O `GNU Mailman`_ é uma gerenciador de listas de email tradicionalmente
47		- usado por diversas organizações no Brasil e no mundo.
48		-
49		-.. _`GNU Mailman`: http://www.gnu.org/software/mailman/
50		-
51		-O restando deste manual descreve a arquitetura do SPB bem como os
52		-procedimentos necessários para sua implantação, manutenção, backup e
53		-restauração e gestão de firewall.
54		-
55		-