Documentação do Software Público Brasileiro (SPB)

Introdução

Bem-vindo a documentação do Portal do Software Público Brasileiro.

O Portal do Software Público Brasileiro (SPB), na prática, é um sistema Web que se consolidou como um ambiente de compartilhamento de softwares. O projeto de evolução deste portal está sendo desenvolvido pela Universidade de Brasília.

Hoje o SPB é um sistema Web composto por ferramentas livres integradas porém com desenvolvimento e comunidades independentes.

As ferramentas que compõe o Software Público são:

  • Mailman: Para lista de e-mail estamos utilizando o Mailman na versão 2, que é um software gratuito para gerenciamento de discussão eletrônica de e-mail e listas e-newsletter;
  • Noosfero: Para rede social estamos utilizando o Noosfero que é uma plataforma web livre para criação de redes sociais com blog, e-Portifólios, CMS, RSS, discussão temática, agenda de eventos, galeria de imagens, chat, entre outros. Ele foi desenvolvido pela Cooperativa de Tecnologias Livres – Colivre 3 em 2007, sob a licença AGPL v.3, com a proposta de permitir ao usuário criar sua própria rede social personalizada, livre e autônoma;
  • Gitlab: Para Forge para Git estamos utilizando o GitLab, que é um software livre de colaboração de código online que utiliza a ferramenta de gerência de código fonte Git;
  • Solr: Para Plataforma de Buscas estamos utilizando Apache Solr, que é uma plataforma de busca open source da Apache Lucene escrita em Java;
  • Persona: Para suporte a autentição Federada estamos utilizando o Mozilla Persona, que foi desenvolvido pela Mozilla Foundation.
  • Colab: Para integrar todas estas ferramentas estamos utilizando o Colab, que é uma plataforma de integração de ferramentas. Nele, são também integradas as interfaces das ferramentas para que, ao navegar, o usuário tenha a sensação de estar navegando em uma única ferramenta.

Conteúdos

Instalação

Para instalação das ferramentas que compõem o Software Público, é necessária a instalação de um conjunto de pacotes RPM. Um pacote RPM consiste em uma coleção de uma ou mais ferramentas que permite um meio automático de instalação, atualização, configuração e remoção de softwares.

O processo de instalação aqui descrito permite a instalação e configuração desses pacotes em uma máquina com o Sistema Operacional CentOS 7 instalado e atualizado. Os pacotes a seguir já são fornecidos nativamente pelo Sistema Operacional, não sendo necessária uma configuração adicional para a instalação dos mesmos.

  • Mailman
  • Nginx
  • PostgreSQL Server

Somados a esses, alguns pacotes não fornecidos nativamente também são necessários. Os mesmos estão listados a seguir.

  • Noosfero
  • Gitlab
  • Solr
  • Colab
  • Colab-deps
  • Mailman-api

Para disponibilizar cada pacote não nativo do CentOS 7, fez-se um levantamento das dependências de cada ferramenta empacotada, bem como do processo de instalação de cada uma, de modo a automatizar esse processo. A seção Dependências descreve brevemente o levantamento de dependências feito.

Repositório do SPB

Para instalação dos pacotes existentes no repositório do SPB através do gerenciador de instalação e remoção de pacotes do CentOS (o Yum), é preciso adicionar o arquivo de configuração desse repositório no diretório /etc/yum.repos./ do Sistema Operacional onde o Portal do Software Público deve Procedimento:

Os comandos a seguir devem ser executados via terminal, com permissões de super usuário do sistema.

  1. Instalar (caso não esteja instalado) o programa wget, para download das configurações de repositório
yum install -y wget
  1. Ir para o diretório /etc/yum.repos./
cd /etc/yum.repos./
  1. Fazer o download dos arquivos de configuração nesse diretório:
wget http://download.opensuse.org/repositories/isv:/spb:/colab/CentOS_7/isv:spb:colab.repo
wget http://download.opensuse.org/repositories/isv:/spb:/mailman-api/CentOS_7/isv:spb:mailman-api.repo

Instalação das Ferramentas (via pacote)

Após a configuração do repositório do SPB, todos os pacotes deverão estar disponíveis através do yum. Ainda que algumas dependências sejam tratadas automaticamente, o comportamento de alguns pacotes é dependente da ordem em que os mesmos são instalados. Portanto, deve-se executar a instalação na ordem especificada a seguir. Os comandos a seguir devem ser executados via terminal, com permissões de super usuário do sistema.

Procedimento:

  1. Instalar o pacote PostreSQL Server
yum install postgresql-server
  1. Instalar os pacotes do Colab, Noosfero e Gitlab
yum install colab noosfero gitlab
  1. Instalar os pacotes Nginx
yum install nginx

Configurações

Nginx

Para configurar o Nginx crie o arquivo /etc/nginx/sites-enabled/colab.conf com o conteúdo abaixo:

upstream colab {
  server                127.0.0.1:8001  fail_timeout=10s;
}

server {
  listen                *:80;

  server_name           beta.softwarepublico.gov.br;
  return                301 https://$server_name$request_uri;
}

server {
  listen                *:443 ssl;

  server_name           beta.softwarepublico.gov.br;

  ssl on;

  ssl_certificate           /etc/nginx/colab.crt;
  ssl_certificate_key       /etc/nginx/colab.key;
  ssl_session_cache         shared:SSL:10m;
  ssl_session_timeout       5m;
  ssl_protocols             SSLv3 TLSv1 TLSv1.1 TLSv1.2;
  ssl_ciphers               HIGH:!aNULL:!MD5;
  ssl_prefer_server_ciphers on;

  access_log            /var/log/nginx/ssl-colab.access.log;
  error_log             /var/log/nginx/ssl-colab.error.log;

  location /gitlab/assets/ {
    alias  /opt/gitlab/embedded/service/gitlab-rails/public/assets/;
  }

  location / {
    root  /usr/share/nginx/colab;
    try_files $uri @colab-app;
  }

  location @colab-app {
    proxy_pass              http://colab;
    proxy_read_timeout      90;
    proxy_connect_timeout   90;
    proxy_redirect          off;
    proxy_set_header        Host $host;
    proxy_set_header        X-Real-IP $remote_addr;
    proxy_set_header        X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header        X-Forwarded-Proto https;
  }
}

Substitua o domínio de exemplo beta.softwarepublico.gov.br pelo domínio desejado.

Certifique-se de instalar o certificado SSL (/etc/nginx/colab.crt) e sua chave privada (/etc/nginx/colab.crt).

Reinicie o serviço do Nginx com o comando: sudo service nginx restart.

Colab

Crie/edite o arquivo /etc/colab/settings.d/admins.yaml e adicione o nome e e-mail dos administradores do sistema:

## System admins
ADMINS: &admin
  -
    - John Foo
    - john@example.com
      -
        - Mary Bar
        - mary@example.com

MANAGERS: *admin

Crie/edite o arquivo /etc/colab/settings.d/hosts.yaml e configure a URL principal da aplicação, quais hosts deverão aceitar requisições e quais hosts poderão ser utilizadas para que o login seja efetuado. Exemplo:

SITE_URL: 'https://beta.softwarepublico.gov.br'

ALLOWED_HOSTS:
  - beta.softwarepublico.gov.br

BROWSERID_AUDIENCES:
  - http://beta.softwarepublico.gov.br
  - https://beta.softwarepublico.gov.br

Crie/edite o arquivo /etc/colab/settings.d/email.yaml e configure o endereço que será utilizado no FROM dos e-mails enviados pelo Colab. Veja o exemplo:

COLAB_FROM_ADDRESS: '"Portal do Software Publico" <noreply@beta.softwarepublico.gov.br>'
SERVER_EMAIL: '"Portal do Software Publico" <noreply@beta.softwarepublico.gov.br>'

Crie/edite o arquivo /etc/colab/settings.d/conversejs.yaml e desative o Converse.js:

CONVERSEJS_ENABLED: False

Crie/edite o arquivo /etc/colab/settings.d/feedzilla.yaml e desative o Feedzilla (blog planet):

FEEDZILLA_ENABLED: False

(opcional) Crie/edite o arquivo /etc/colab/settings.d/raven.yaml e adicione a string de conexão da sua instancia do Sentry como no exemplo abaixo:

### Log errors to Sentry instance
RAVEN_DSN: 'https://<user>:<key>@sentry.example.com/<id>'

Após editar todos os arquivos desejados reinicie o processo do Colab com utilizando o comando service colab restart.

Gitlab

Crie/edite o arquivo /etc/gitlab/gitlab.rb com o seguinte conteúdo:

external_url 'https://beta.softwarepublico.gov.br'
gitlab_rails['internal_api_url'] = 'http://127.0.0.1:8090/gitlab'
nginx['enable'] = false
unicorn['enable'] = true
unicorn['port'] = 8090
postgresql['port'] = 5433
gitlab_rails['gitlab_https'] = true
gitlab_rails['env_enable'] = true
gitlab_rails['env_database_name'] = 'colab'
gitlab_rails['env_database_host'] = '127.0.0.1'
gitlab_rails['env_database_user'] = '<usuario_do_postgresql>'
gitlab_rails['env_database_password'] = '<senha_do_postgresql>'
gitlab_rails['omniauth_enabled'] = true
gitlab_rails['omniauth_allow_single_sign_on'] = true
gitlab_rails['omniauth_block_auto_created_users'] = false

Substitua o domínio beta.softwarepublico.gov.br pelo desejado, e configure o usuário e senha que terão acesso ao banco de dados.

Execute o comando para regerar a configuração do Gitlab: gitlab-ctl reconfigure. Ao termino da reconfiguração o script irá reiniciar o serviço automaticamente.

Noosfero
Mailman

Dependências

O repositório do SPB contém os pacotes que não são nativos do Sistema Operacional onde o mesmo o sistema do Portal do Software Público deve ser instalado. Esse repositório contém os pacotes referentes ao Bottle, Mailman-api, Solr, Colab e às dependências do Colab (pacote Colab-deps).

Colab

Esse pacote, contém o sistema Colab. O processo de criação desse pacote depende do pacote python-virtualenv, além de um conjunto de dependências python, contidos no pacote colab-deps, descrito na próxima seção. O processo de instalação desse pacote requer uma instalação prévia do pacote colab-deps, que é instalado automaticamente se o repositório do mesmo estiver disponível no conjunto de repositórios do yum.

Colab-deps

Este pacote contém as dependências python do Colab. Tais dependências foram encapsuladas em um ambiente virtual python (python-virtualenv), permitindo uma maior independência e, consequentemente, compatibilidade com o Sistema Operacional no qual o pacote seja instalado. Esse pacote é composto pelas ferramentas listadas a seguir.

  • Chardet
  • Django
  • Django-browserid
  • Django-cliauth
  • Django-common
  • Django-conversejs
  • Django-haystack
  • Django-hitcounter
  • Django-i18n-model
  • Django-mobile
  • Django-mptt
  • Django-piston
  • Django-revproxy
  • Django-taggit
  • Django-tastypie
  • Dpaste
  • Etiquetando
  • Eventlet
  • Fancy_tag
  • Feedzilla
  • Grab
  • Gunicorn
  • Html2text
  • Lorem-ipsum-generator
  • Lxml
  • Paste
  • Pip
  • Poster
  • Psycopg2
  • Pure-sasl
  • Pygments
  • Pysolr
  • Python-dateutil
  • Python-memcached
  • Python-mimeparse
  • PyYAML
  • Raven
  • Repoze.lru
  • Requests
  • Setuptools
  • Six
  • Sleekxmpp
  • South
  • Stemming
  • Tornado
  • Transliterate

Mailman-api

Esse pacote contém o Mailman-api. Esta ferramenta python possui como dependência os pacotes Bottle e python. Como o Bottle não é provido nativamente pelo CentOS 7, foi necessário empacotá-lo separadamente.

Bottle

Esse pacote contém a ferramenta Bottle, um framowork web escrito em python, e requisito para a utilização da ferramenta Mailman-api. Este pacote possui como dependência o pacote python, que está disponível nativamente no CentOS.

Solr

Esse pacote contém a ferramenta python Bottle, e integra o conjunto de ferramentas do SPB. Sua instalação requer o pacote Java, que já existe nativamente no CentOS.