Compare View

switch
from
...
to
 
Commits (5)
Showing 6 changed files   Show diff stats
docs/busca_global.rst.in 0 → 100644
  Diff comments   View file @1026641
... ... @@ -0,0 +1,37 @@
  1 +Busca Global
  2 +==========
  3 +
  4 +Esta seção visa documentar o que é indexado pelo Portal do Software Público
  5 +Brasileiro e se torna acessível via busca global.
  6 +
  7 +Segue abaixo uma lista de entidades que podem ser buscadas por ferramenta:
  8 +
  9 +Noosfero (Social)
  10 +-------
  11 +
  12 +- Artigo
  13 +- Comunidade
  14 +- Comunidade de Software
  15 +- Comentário
  16 +
  17 +
  18 +Gitlab (Desenvolvimento)
  19 +------
  20 +
  21 +- Projetos
  22 +- Merge Request
  23 +- Issue
  24 +- Comentário
  25 +
  26 +
  27 +Colab (Integração)
  28 +-----
  29 +
  30 +- Usuário
  31 +
  32 +
  33 +Mailman (Listas de email)
  34 +-----
  35 +
  36 +- Lista de Discussões
  37 +
... ...
docs/conf.py.in
  Diff comments   View file @1026641
... ... @@ -44,16 +44,16 @@ master_doc = 'index'
44 44  
45 45 # General information about the project.
46 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'
  47 +copyright = u'2014-2016, Universidade de Brasília - UnB. Documentação licenciada sob a Licença Creative Commons Atribuição-CompartilhaIgual 4.0 Internacional'
48 48  
49 49 # The version info for the project you're documenting, acts as replacement for
50 50 # |version| and |release|, also used in various other places throughout the
51 51 # built documents.
52 52 #
53 53 # The short X.Y version.
54   -version = '3'
  54 +version = '5'
55 55 # The full version, including alpha/beta/rc tags.
56   -release = '3'
  56 +release = '2'
57 57  
58 58 # The language for content autogenerated by Sphinx. Refer to documentation
59 59 # for a list of supported languages.
... ...
docs/index.rst.in
  Diff comments   View file @1026641
... ... @@ -12,3 +12,5 @@ Software Público Brasileiro: Manual de Operação (@@SPB_ENV@@)
12 12 firewall
13 13 export_data
14 14 apoio
  15 + busca_global
  16 + pacotes
... ...
docs/manutencao.rst.in
  Diff comments   View file @1026641
... ... @@ -139,17 +139,40 @@ do Nginx `cookbooks/reverse_proxy/templates/reverse_proxy.conf.erb` na variável
139 139 `client_max_upload_size`. O valor deve ser definido como `<valor>m`. Exemplo
140 140 `client_max_body_size = 500m` sendo 500m o maior limite entre as ferramentas.
141 141  
142   - **Nota** Ferramenta Gitlab
  142 +Atualizando Certificado Digital
  143 +---------------
  144 +
  145 +A atualização do certificado digital do Portal é feito através das receitas Chef
  146 +(especificamente esta: `cookbooks/reverse_proxy/recipes/default.rb`), e os mesmos
  147 +se tornam disponíveis na máquina `reverseproxy`. Entretanto deve-se estar atento
  148 +para o nome dos arquivos e o formato dos mesmos.
  149 +
  150 +Ao gerar o certificado digital deverão ser gerados dois arquivos: o certificado
  151 +e a chave. O certificado deve estar no formato x509 e recomenda-se que a chave
  152 +seja gerada usando o algoritmo de criptografia RSA. Tendo isso, o nome dos arquivos
  153 +devem seguir o que é especificado na receita, que usa a variável
  154 +`node['config']['external_hostname']` do arquivo de configuração, sendo essa
  155 +variável o domínio do ambiente (por exemplo, 'softwarepublico.gov.br'). O nome
  156 +dos arquivos devem seguir o seguinte padrão:
  157 +
  158 ++ Certificado: $external_hostname.crt (nome do domínio com extensão crt)
  159 ++ Chave: $external_hostname.key (nome do domínio com extensão key)
  160 +
  161 +Com os arquivos no formato e nomenclatura corretos basta colocá-los no diretório
  162 +`cookbooks/reverse_proxy/files/host-reverseproxy/` e convergir o ambiente
  163 +normalmente.
  164 +
  165 +Nota Ferramenta Gitlab
143 166 ------------
144 167  
145 168 Atualmente o SPB está utilizando o Gitlab versão 7.6.2 mantido no repositório
146   -de pacotes RPM `Softwarepublico Copr Fedora`_ . O pacote é criado e mantido
  169 +de pacotes RPM Softwarepublico `Copr Fedora` . O pacote é criado e mantido
147 170 pelo SPB, ou seja, a instancia do Gitlab contém as configurações necessárias
148 171 para a integração com as ferramenta e ambiente do SPB. Os pacotes de instação
149 172 providos pelo próprio Gitlab não tem a garantia de funcionamento com o SPB.
150 173  
151 174 Há uma atualização do pacote Gitlab v8.5.0 disponível no projeto *eperimental* no
152   -mesmo repositório ( `Softwarepublico Copr Fedora`_ ) . O serviço é instanciado
  175 +mesmo repositório ( Softwarepublico `Copr Fedora` ) . O serviço é instanciado
153 176 e é possível utiliza-lo em *stand alone*. Entretanto não foi realizado a
154 177 integração e testes do novo pacote com o ambiente e ferramentas do SPB.
155 178  
... ...
docs/pacotes.rst.in 0 → 100644
  Diff comments   View file @1026641
... ... @@ -0,0 +1,34 @@
  1 +Pacotes das Ferramentas
  2 +==========
  3 +
  4 +As ferramentas utilizadas no SPB são mantidas no repositório de pacotes
  5 +`Copr Fedora`. Cada projeto contém um conjunto de pacotes RPM para instalação
  6 +das ferramentas seguindo uma versão, exemplo, o projeto v4 contém os pacotes
  7 +construidos para a versão stable-4.x (versão referente a branch utilizada para
  8 +o converge). O projeto experimental contém os pacotes em versão de teste e pode
  9 +apresentar instabilidade.
  10 +
  11 +.. _`Copr Fedora`: https://copr.fedorainfracloud.org/coprs/softwarepublico/
  12 +
  13 +Versão
  14 +------------
  15 +
  16 +Os pacotes são construidos com a utilização dos arquivos specs localizados em
  17 +``softwarepublico/src/pkg-rpm/<pacote>/*.spec`` (repositório oficial do Softwarepublico)
  18 +e cada pacote contem a sua versão definida pelo atributo ``Version``
  19 +(mais informações sobre pacote RPM `aqui`).
  20 +
  21 +Para os pacotes *noosfero-spb*, *colab-spb-theme* e *colab-spb-plugin* tem a versão
  22 +definida no arquivo VERSION na pasta raíz do repositório oficial do Softwarepublico.
  23 +A lógica de criação desses pacotes são definidas no arquivo Makefile em
  24 +``softwarepublico/src/Makefile`` e podem ser atualizados utilizando o comando
  25 +``make release`` do qual automaticamente realizam o upload do arquivo.
  26 +
  27 +**Nota**: o arquivo VERSION foi criado ao final da release 4/início da release 5.
  28 +A sua primeira versão foi lançada com ``5.0a0``, ou seja, não existe a versão
  29 +``4.XaY``, portanto os pacotes referentes a v4 e branch stable-4.X contém os
  30 +pacotes com as tags ``5.0a0`` não tendo correlação direta de versão.
  31 +
  32 +.. _`aqui`: https://fedoraproject.org/wiki/How_to_create_an_RPM_package/pt
  33 +
  34 +
... ...
src/README.md 0 → 100644
  Diff comments   View file @1026641
... ... @@ -0,0 +1,73 @@
  1 +# Building Packages
  2 +
  3 +This path and scripts automates the build and update the packages for SPB project.
  4 +It's can be done manually, but we don't recommend.
  5 +
  6 +## Requirements
  7 +
  8 +First, this will only works (at least was tested) on a RedHat based system
  9 +(Fedora, CentOS, etc). Everything you need to know about packing for the system
  10 +is available [here](https://fedoraproject.org/wiki/How_to_create_an_RPM_package/pt)
  11 +
  12 +Dependency packages
  13 +
  14 +```
  15 +# yum install @development-tools
  16 +# yum install fedora-packager
  17 +# yum install copr-cli
  18 +# yum install git
  19 +```
  20 +
  21 +You need a account on [Copr Fedora](https://copr.fedorainfracloud.org) and the api token to
  22 +authenticate when upload. Just follow the instruction on the
  23 +[API](https://copr.fedorainfracloud.org/api/).
  24 +
  25 +You need your GPG key in the machine. If you don't have one follow the
  26 +instruction [here](https://fedoraproject.org/wiki/Creating_GPG_Keys/pt-br)
  27 +
  28 +## Usage
  29 +
  30 +### Make Release
  31 +
  32 +Make Release are made to build *colab-spb-plugin*, *colab-spb-theme* e
  33 +*noosfero-spb*. Bump the VERSION file on the root directory and runs
  34 +into the src/ directory:
  35 +
  36 +```
  37 +$ make release
  38 +```
  39 +
  40 +Follow the instructions and done :).
  41 +Don't forget to push the changes to the repository.
  42 +
  43 +### Build Packages
  44 +
  45 +To build the others packages.
  46 +
  47 +**First**: Build the **tarball** of the
  48 +core project. Pay attention to how to build this, some projects needs
  49 +requirements or pre-command before create the **tarball**.
  50 +
  51 +In most of the cases you just needs to run into the project repository:
  52 +```
  53 + $ git archive --format=tar.gz --prefix=<pkg-name>-<pkg-version>/ <tag or branch> > <pkg-name>-<pkg-version>.tar.gz
  54 + or
  55 + $ make sdist
  56 +```
  57 +
  58 +**Second**: Copy the **tarball** into the pkg-rpm/<project>/
  59 +
  60 +**Third**: Runs into the src/pkg-rpm/:
  61 +```
  62 + $ make <project>-build
  63 + and
  64 + $ make <project>-upload
  65 +```
  66 +
  67 +The first will build the package and the second will upload to
  68 +the copr repository using copr-cli.
  69 +
  70 +**Note**: the copr repository is defined into *src/pkg-rpm/Makefile*.
  71 +
  72 +**Important**: Make sure that you have all the build dependencies installed.
  73 +Just check the .spec file to verify which are.
... ...