Download as
Browse Code »

Commit ad506c0730b64c3f7baa7db36b27d7600da25ddf

Authored by Antonio Terceiro
1 parent df29bbe2
Exists in master and in 90 other branches 3.x, add_sisp_to_chef, add_super_archives_plugin, api_for_colab, automates_core_packing, backup, backup_not_prod, cdtc_configuration, changes_in_buttons_on_content_panel, colab_automated_login, colab_spb_plugin_recipe, colab_widgets_settings, design_validation, dev-lappis, dev_env_minimal, disable_email_dev, docs, fix_breadcrumbs_position, fix_categories_software_link, fix_edit_institution, fix_edit_software_with_another_license, fix_get_license_info, fix_gitlab_assets_permission, fix_list_style_inside_article, fix_list_style_on_folder_elements, fix_members_pagination, fix_merge_request_url, fix_models_translations, fix_no_license, fix_software_api, fix_software_block_migration, fix_software_communities_translations, fix_software_communities_unit_test, fix_style_create_institution_admin_panel, fix_superarchives_imports, fix_sym_links_noosfero, focus_search_field_theme, gov-user-refactoring, gov-user-refactoring-rails4, header_fix, institution_modal_on_rating, kalibro-conf-refactoring, kalibro-processor-package, lxc_settings, margin_fix, mezuro_cookbook, performance, prezento, r3, refactor_download_block, refactor_software_communities, refactor_software_for_sisp, register_page, release-process, release-process-v2, remove-unused-images, remove_backup_emails, remove_broken_theme, remove_secondary_email_from_user, remove_sisp_buttons, removing_super_archives_email, review_message, scope2method, signals_user_noosfero, sisp_catalog_header, sisp_colab_config, sisp_dev, sisp_dev_master, sisp_simple_version, software_as_organization, software_catalog_style_fix, software_communities_html_refactor, software_infos_api, spb_minimal_env, spb_to_rails4, spec_refactor, stable-4.1, stable-4.2, stable-4.x, stable-devel, support_docs, syslog, temp_soft_comm_refactoring, theme_header, theme_javascript_refactory, thread_dropdown, thread_page, update_search_by_categories, update_software_api, update_softwares_boxes

docs: move all autogenerated files to _build/

Showing 7 changed files with 198 additions and 499 deletions   Show diff stats
docs/.gitignore
View file @df29bbe
... ... @@ -1,3 +0,0 @@
1   -architecture.png
2   -*.rst
3   -conf.py
docs/Makefile
  Diff comments   View file @ad506c0
1   -# Makefile for Sphinx documentation
2   -#
3   -
4   -# You can set these variables from the command line.
5   -SPHINXOPTS =
6   -SPHINXBUILD = sphinx-build
7   -PAPER =
8   -BUILDDIR = _build
9   -
10   -# User-friendly check for sphinx-build
11   -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12   -$(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/)
13   -endif
14   -
15   -# Internal variables.
16   -PAPEROPT_a4 = -D latex_paper_size=a4
17   -PAPEROPT_letter = -D latex_paper_size=letter
18   -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
19   -# the i18n builder cannot share the environment and doctrees with the others
20   -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
21   -
22   -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
23   -
24   -help:
25   - @echo "Please use \`make <target>' where <target> is one of"
26   - @echo " html to make standalone HTML files"
27   - @echo " dirhtml to make HTML files named index.html in directories"
28   - @echo " singlehtml to make a single large HTML file"
29   - @echo " pickle to make pickle files"
30   - @echo " json to make JSON files"
31   - @echo " htmlhelp to make HTML files and a HTML help project"
32   - @echo " qthelp to make HTML files and a qthelp project"
33   - @echo " devhelp to make HTML files and a Devhelp project"
34   - @echo " epub to make an epub"
35   - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36   - @echo " latexpdf to make LaTeX files and run them through pdflatex"
37   - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
38   - @echo " text to make text files"
39   - @echo " man to make manual pages"
40   - @echo " texinfo to make Texinfo files"
41   - @echo " info to make Texinfo files and run them through makeinfo"
42   - @echo " gettext to make PO message catalogs"
43   - @echo " changes to make an overview of all changed/added/deprecated items"
44   - @echo " xml to make Docutils-native XML files"
45   - @echo " pseudoxml to make pseudoxml-XML files for display purposes"
46   - @echo " linkcheck to check all external links for integrity"
47   - @echo " doctest to run all doctests embedded in the documentation (if enabled)"
48   -
49   -include local.mk
50   -
51   -clean:
52   - rm -rf $(BUILDDIR)/*
53   - rm -rf $(CLEAN_FILES)
54   -
55   -html: $(BUILT)
56   - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  1 +all:
  2 + @echo "Usage:"
57 3 @echo
58   - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  4 + @echo "make html Builds the documentation in HTML"
  5 + @echo "make latexpdf Builds the documentation in PDF"
59 6  
60   -dirhtml: $(BUILT)
61   - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
62   - @echo
63   - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  7 +SPB_ENV ?= local
64 8  
65   -singlehtml: $(BUILT)
66   - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
67   - @echo
68   - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  9 +# autogenerated DNS documentation
  10 +BUILT += _build/dns.rst
  11 +_build/dns.rst: ../test/dns_test.sh
  12 + (cd .. && sh test/dns_test.sh --doc) > $@
69 13  
70   -pickle: $(BUILT)
71   - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
72   - @echo
73   - @echo "Build finished; now you can process the pickle files."
74   -
75   -json: $(BUILT)
76   - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
77   - @echo
78   - @echo "Build finished; now you can process the JSON files."
79   -
80   -htmlhelp: $(BUILT)
81   - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
82   - @echo
83   - @echo "Build finished; now you can run HTML Help Workshop with the" \
84   - ".hhp project file in $(BUILDDIR)/htmlhelp."
  14 +BUILT += $(patsubst %.svg, _build/%.png, $(wildcard *.svg))
  15 +_build/%.png: %.svg
  16 + inkscape --export-area-page --export-width=800 --export-width=600 --export-png=$@ $<
85 17  
86   -qthelp: $(BUILT)
87   - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
88   - @echo
89   - @echo "Build finished; now you can run "qcollectiongenerator" with the" \
90   - ".qhcp project file in $(BUILDDIR)/qthelp, like this: $(BUILT)"
91   - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/softwarepublico.qhcp"
92   - @echo "To view the help file: $(BUILT)"
93   - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/softwarepublico.qhc"
  18 +BUILT += $(patsubst %.in, _build/%, $(wildcard *.in))
  19 +_build/%: %.in build.rb
  20 + ruby -p build.rb $< > $@ || ($(RM) $@; false)
94 21  
95   -devhelp: $(BUILT)
96   - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
97   - @echo
98   - @echo "Build finished."
99   - @echo "To view the help file: $(BUILT)"
100   - @echo "# mkdir -p $$HOME/.local/share/devhelp/softwarepublico"
101   - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/softwarepublico"
102   - @echo "# devhelp"
  22 +CLEAN_FILES += $(BUILT)
103 23  
104   -epub: $(BUILT)
105   - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
106   - @echo
107   - @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
108   -
109   -latex: $(BUILT)
110   - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
111   - @echo
112   - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
113   - @echo "Run \`make' in that directory to run these through (pdf)latex" \
114   - "(use \`make latexpdf' here to do that automatically)."
  24 +html latexpdf: $(BUILT)
  25 + $(MAKE) -C _build $@
115 26  
116   -latexpdf: $(BUILT)
117   - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
118   - @echo "Running LaTeX files through pdflatex..."
119   - $(MAKE) -C $(BUILDDIR)/latex all-pdf
120   - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
121   -
122   -latexpdfja: $(BUILT)
123   - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
124   - @echo "Running LaTeX files through platex and dvipdfmx..."
125   - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
126   - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
127   -
128   -text: $(BUILT)
129   - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
130   - @echo
131   - @echo "Build finished. The text files are in $(BUILDDIR)/text."
132   -
133   -man: $(BUILT)
134   - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
135   - @echo
136   - @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
137   -
138   -texinfo: $(BUILT)
139   - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
140   - @echo
141   - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
142   - @echo "Run \`make' in that directory to run these through makeinfo" \
143   - "(use \`make info' here to do that automatically)."
144   -
145   -info: $(BUILT)
146   - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
147   - @echo "Running Texinfo files through makeinfo..."
148   - make -C $(BUILDDIR)/texinfo info
149   - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
150   -
151   -gettext: $(BUILT)
152   - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
153   - @echo
154   - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
155   -
156   -changes: $(BUILT)
157   - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
158   - @echo
159   - @echo "The overview file is in $(BUILDDIR)/changes."
160   -
161   -linkcheck: $(BUILT)
162   - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
163   - @echo
164   - @echo "Link check complete; look for any errors in the above output " \
165   - "or in $(BUILDDIR)/linkcheck/output.txt."
166   -
167   -doctest: $(BUILT)
168   - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
169   - @echo "Testing of doctests in the sources finished, look at the " \
170   - "results in $(BUILDDIR)/doctest/output.txt."
171   -
172   -xml: $(BUILT)
173   - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
174   - @echo
175   - @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
176   -
177   -pseudoxml: $(BUILT)
178   - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
179   - @echo
180   - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
  27 +clean:
  28 + $(RM) $(BUILT)
  29 + $(MAKE) -C _build $@
... ...
docs/_build/Makefile 0 → 100644
  Diff comments   View file @ad506c0
... ... @@ -0,0 +1,177 @@
  1 +# Makefile for Sphinx documentation
  2 +#
  3 +
  4 +# You can set these variables from the command line.
  5 +SPHINXOPTS =
  6 +SPHINXBUILD = sphinx-build
  7 +PAPER =
  8 +BUILDDIR = .
  9 +
  10 +# User-friendly check for sphinx-build
  11 +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
  12 +$(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/)
  13 +endif
  14 +
  15 +# Internal variables.
  16 +PAPEROPT_a4 = -D latex_paper_size=a4
  17 +PAPEROPT_letter = -D latex_paper_size=letter
  18 +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  19 +# the i18n builder cannot share the environment and doctrees with the others
  20 +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  21 +
  22 +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
  23 +
  24 +help:
  25 + @echo "Please use \`make <target>' where <target> is one of"
  26 + @echo " html to make standalone HTML files"
  27 + @echo " dirhtml to make HTML files named index.html in directories"
  28 + @echo " singlehtml to make a single large HTML file"
  29 + @echo " pickle to make pickle files"
  30 + @echo " json to make JSON files"
  31 + @echo " htmlhelp to make HTML files and a HTML help project"
  32 + @echo " qthelp to make HTML files and a qthelp project"
  33 + @echo " devhelp to make HTML files and a Devhelp project"
  34 + @echo " epub to make an epub"
  35 + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  36 + @echo " latexpdf to make LaTeX files and run them through pdflatex"
  37 + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
  38 + @echo " text to make text files"
  39 + @echo " man to make manual pages"
  40 + @echo " texinfo to make Texinfo files"
  41 + @echo " info to make Texinfo files and run them through makeinfo"
  42 + @echo " gettext to make PO message catalogs"
  43 + @echo " changes to make an overview of all changed/added/deprecated items"
  44 + @echo " xml to make Docutils-native XML files"
  45 + @echo " pseudoxml to make pseudoxml-XML files for display purposes"
  46 + @echo " linkcheck to check all external links for integrity"
  47 + @echo " doctest to run all doctests embedded in the documentation (if enabled)"
  48 +
  49 +clean:
  50 + rm -rf $(BUILDDIR)/[a-z]*
  51 +
  52 +html:
  53 + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  54 + @echo
  55 + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  56 +
  57 +dirhtml:
  58 + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  59 + @echo
  60 + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  61 +
  62 +singlehtml:
  63 + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  64 + @echo
  65 + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  66 +
  67 +pickle:
  68 + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  69 + @echo
  70 + @echo "Build finished; now you can process the pickle files."
  71 +
  72 +json:
  73 + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  74 + @echo
  75 + @echo "Build finished; now you can process the JSON files."
  76 +
  77 +htmlhelp:
  78 + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  79 + @echo
  80 + @echo "Build finished; now you can run HTML Help Workshop with the" \
  81 + ".hhp project file in $(BUILDDIR)/htmlhelp."
  82 +
  83 +qthelp:
  84 + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  85 + @echo
  86 + @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  87 +
  88 + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/softwarepublico.qhcp"
  89 + @echo
  90 + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/softwarepublico.qhc"
  91 +
  92 +devhelp:
  93 + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
  94 + @echo
  95 + @echo "Build finished."
  96 + @echo
  97 + @echo "# mkdir -p $$HOME/.local/share/devhelp/softwarepublico"
  98 + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/softwarepublico"
  99 + @echo "# devhelp"
  100 +
  101 +epub:
  102 + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
  103 + @echo
  104 + @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
  105 +
  106 +latex:
  107 + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  108 + @echo
  109 + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
  110 + @echo "Run \`make' in that directory to run these through (pdf)latex" \
  111 + "(use \`make latexpdf' here to do that automatically)."
  112 +
  113 +latexpdf:
  114 + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  115 + @echo "Running LaTeX files through pdflatex..."
  116 + $(MAKE) -C $(BUILDDIR)/latex all-pdf
  117 + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  118 +
  119 +latexpdfja:
  120 + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  121 + @echo "Running LaTeX files through platex and dvipdfmx..."
  122 + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
  123 + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  124 +
  125 +text:
  126 + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
  127 + @echo
  128 + @echo "Build finished. The text files are in $(BUILDDIR)/text."
  129 +
  130 +man:
  131 + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
  132 + @echo
  133 + @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
  134 +
  135 +texinfo:
  136 + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  137 + @echo
  138 + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
  139 + @echo "Run \`make' in that directory to run these through makeinfo" \
  140 + "(use \`make info' here to do that automatically)."
  141 +
  142 +info:
  143 + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  144 + @echo "Running Texinfo files through makeinfo..."
  145 + make -C $(BUILDDIR)/texinfo info
  146 + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
  147 +
  148 +gettext:
  149 + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
  150 + @echo
  151 + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
  152 +
  153 +changes:
  154 + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
  155 + @echo
  156 + @echo "The overview file is in $(BUILDDIR)/changes."
  157 +
  158 +linkcheck:
  159 + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
  160 + @echo
  161 + @echo "Link check complete; look for any errors in the above output " \
  162 + "or in $(BUILDDIR)/linkcheck/output.txt."
  163 +
  164 +doctest:
  165 + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
  166 + @echo "Testing of doctests in the sources finished, look at the " \
  167 + "results in $(BUILDDIR)/doctest/output.txt."
  168 +
  169 +xml:
  170 + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
  171 + @echo
  172 + @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
  173 +
  174 +pseudoxml:
  175 + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
  176 + @echo
  177 + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
... ...
docs/arquitetura.png
View file @df29bbe

40.7 KB
docs/firewall.rstin
View file @df29bbe
... ... @@ -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).
docs/local.mk
View file @df29bbe
... ... @@ -1,17 +0,0 @@
1   -# autogenerated DNS documentation
2   -
3   -SPB_ENV ?= local
4   -
5   -BUILT += dns.rst
6   -dns.rst: ../test/dns_test.sh
7   - (cd .. && sh test/dns_test.sh --doc) > $@
8   -
9   -BUILT += arquitetura.png
10   -%.png: %.svg
11   - inkscape --export-area-page --export-width=800 --export-width=600 --export-png=$@ $<
12   -
13   -BUILT += $(patsubst %.in, %, $(wildcard *.in))
14   -%: %.in build.rb
15   - ruby -p build.rb $< > $@ || ($(RM) $@; false)
16   -
17   -CLEAN_FILES += $(BUILT)
docs/make.bat
View file @df29bbe
... ... @@ -1,242 +0,0 @@
1   -@ECHO OFF
2   -
3   -REM Command file for Sphinx documentation
4   -
5   -if "%SPHINXBUILD%" == "" (
6   - set SPHINXBUILD=sphinx-build
7   -)
8   -set BUILDDIR=_build
9   -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
10   -set I18NSPHINXOPTS=%SPHINXOPTS% .
11   -if NOT "%PAPER%" == "" (
12   - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
13   - set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
14   -)
15   -
16   -if "%1" == "" goto help
17   -
18   -if "%1" == "help" (
19   - :help
20   - echo.Please use `make ^<target^>` where ^<target^> is one of
21   - echo. html to make standalone HTML files
22   - echo. dirhtml to make HTML files named index.html in directories
23   - echo. singlehtml to make a single large HTML file
24   - echo. pickle to make pickle files
25   - echo. json to make JSON files
26   - echo. htmlhelp to make HTML files and a HTML help project
27   - echo. qthelp to make HTML files and a qthelp project
28   - echo. devhelp to make HTML files and a Devhelp project
29   - echo. epub to make an epub
30   - echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
31   - echo. text to make text files
32   - echo. man to make manual pages
33   - echo. texinfo to make Texinfo files
34   - echo. gettext to make PO message catalogs
35   - echo. changes to make an overview over all changed/added/deprecated items
36   - echo. xml to make Docutils-native XML files
37   - echo. pseudoxml to make pseudoxml-XML files for display purposes
38   - echo. linkcheck to check all external links for integrity
39   - echo. doctest to run all doctests embedded in the documentation if enabled
40   - goto end
41   -)
42   -
43   -if "%1" == "clean" (
44   - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
45   - del /q /s %BUILDDIR%\*
46   - goto end
47   -)
48   -
49   -
50   -%SPHINXBUILD% 2> nul
51   -if errorlevel 9009 (
52   - echo.
53   - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
54   - echo.installed, then set the SPHINXBUILD environment variable to point
55   - echo.to the full path of the 'sphinx-build' executable. Alternatively you
56   - echo.may add the Sphinx directory to PATH.
57   - echo.
58   - echo.If you don't have Sphinx installed, grab it from
59   - echo.http://sphinx-doc.org/
60   - exit /b 1
61   -)
62   -
63   -if "%1" == "html" (
64   - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
65   - if errorlevel 1 exit /b 1
66   - echo.
67   - echo.Build finished. The HTML pages are in %BUILDDIR%/html.
68   - goto end
69   -)
70   -
71   -if "%1" == "dirhtml" (
72   - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
73   - if errorlevel 1 exit /b 1
74   - echo.
75   - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
76   - goto end
77   -)
78   -
79   -if "%1" == "singlehtml" (
80   - %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
81   - if errorlevel 1 exit /b 1
82   - echo.
83   - echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
84   - goto end
85   -)
86   -
87   -if "%1" == "pickle" (
88   - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
89   - if errorlevel 1 exit /b 1
90   - echo.
91   - echo.Build finished; now you can process the pickle files.
92   - goto end
93   -)
94   -
95   -if "%1" == "json" (
96   - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
97   - if errorlevel 1 exit /b 1
98   - echo.
99   - echo.Build finished; now you can process the JSON files.
100   - goto end
101   -)
102   -
103   -if "%1" == "htmlhelp" (
104   - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
105   - if errorlevel 1 exit /b 1
106   - echo.
107   - echo.Build finished; now you can run HTML Help Workshop with the ^
108   -.hhp project file in %BUILDDIR%/htmlhelp.
109   - goto end
110   -)
111   -
112   -if "%1" == "qthelp" (
113   - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
114   - if errorlevel 1 exit /b 1
115   - echo.
116   - echo.Build finished; now you can run "qcollectiongenerator" with the ^
117   -.qhcp project file in %BUILDDIR%/qthelp, like this:
118   - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\softwarepublico.qhcp
119   - echo.To view the help file:
120   - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\softwarepublico.ghc
121   - goto end
122   -)
123   -
124   -if "%1" == "devhelp" (
125   - %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
126   - if errorlevel 1 exit /b 1
127   - echo.
128   - echo.Build finished.
129   - goto end
130   -)
131   -
132   -if "%1" == "epub" (
133   - %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
134   - if errorlevel 1 exit /b 1
135   - echo.
136   - echo.Build finished. The epub file is in %BUILDDIR%/epub.
137   - goto end
138   -)
139   -
140   -if "%1" == "latex" (
141   - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
142   - if errorlevel 1 exit /b 1
143   - echo.
144   - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
145   - goto end
146   -)
147   -
148   -if "%1" == "latexpdf" (
149   - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
150   - cd %BUILDDIR%/latex
151   - make all-pdf
152   - cd %BUILDDIR%/..
153   - echo.
154   - echo.Build finished; the PDF files are in %BUILDDIR%/latex.
155   - goto end
156   -)
157   -
158   -if "%1" == "latexpdfja" (
159   - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
160   - cd %BUILDDIR%/latex
161   - make all-pdf-ja
162   - cd %BUILDDIR%/..
163   - echo.
164   - echo.Build finished; the PDF files are in %BUILDDIR%/latex.
165   - goto end
166   -)
167   -
168   -if "%1" == "text" (
169   - %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
170   - if errorlevel 1 exit /b 1
171   - echo.
172   - echo.Build finished. The text files are in %BUILDDIR%/text.
173   - goto end
174   -)
175   -
176   -if "%1" == "man" (
177   - %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
178   - if errorlevel 1 exit /b 1
179   - echo.
180   - echo.Build finished. The manual pages are in %BUILDDIR%/man.
181   - goto end
182   -)
183   -
184   -if "%1" == "texinfo" (
185   - %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
186   - if errorlevel 1 exit /b 1
187   - echo.
188   - echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
189   - goto end
190   -)
191   -
192   -if "%1" == "gettext" (
193   - %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
194   - if errorlevel 1 exit /b 1
195   - echo.
196   - echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
197   - goto end
198   -)
199   -
200   -if "%1" == "changes" (
201   - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
202   - if errorlevel 1 exit /b 1
203   - echo.
204   - echo.The overview file is in %BUILDDIR%/changes.
205   - goto end
206   -)
207   -
208   -if "%1" == "linkcheck" (
209   - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
210   - if errorlevel 1 exit /b 1
211   - echo.
212   - echo.Link check complete; look for any errors in the above output ^
213   -or in %BUILDDIR%/linkcheck/output.txt.
214   - goto end
215   -)
216   -
217   -if "%1" == "doctest" (
218   - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
219   - if errorlevel 1 exit /b 1
220   - echo.
221   - echo.Testing of doctests in the sources finished, look at the ^
222   -results in %BUILDDIR%/doctest/output.txt.
223   - goto end
224   -)
225   -
226   -if "%1" == "xml" (
227   - %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
228   - if errorlevel 1 exit /b 1
229   - echo.
230   - echo.Build finished. The XML files are in %BUILDDIR%/xml.
231   - goto end
232   -)
233   -
234   -if "%1" == "pseudoxml" (
235   - %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
236   - if errorlevel 1 exit /b 1
237   - echo.
238   - echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
239   - goto end
240   -)
241   -
242   -:end