This README is intended for Portuguese audience

• Guia de instalação e configuração do Helios
  • Personalizações feitas no Helios
  • Instalação dos pacotes necessários (Ubuntu 18.04)
    • Softwares necessários
  • Preparação do ambiente para instalação do Helios
    • Configuração do banco de dados PostgreSQL
    • Compilando arquivos com as traduções para português
    • Configuração dos módulos de autenticação
      • Autenticação em uma base LDAP
    • Testando a instalação em ambiente de desenvolvimento
    • Habilitando usuário com permissão de gestor de eleições
  • Preparando ambiente de produção
    • Configuração apache
    • Celery
  • Configurações Gerais:
  • Outras personalizações feitas no Helios
    • Habilitar Interface de Administração do Django
    • Listar eleições na página inicial do Helios
    • Autenticação federada via shibboleth
      • Configuração da autenticação com o módulo apache shibboleth2
      • Habilitando instituições da federação para usarem o serviço Helios
  • Usando docker para desenvolvimento
  • Alguns lembretes finais cruciais para o ambiente de produção

Guia de instalação e configuração do Helios

Este é um repositório particular em que novas funcionalidades, atualizações e outras atividades de interesse particular ou de pesquisa são realizadas.

Se você está interessado em informações sobre o repositório de uso no IFSC (http://www.ifsc.edu.br), por favor acesse https://github.com/ifsc/helios-server

Neste tutorial são descritos os principais passos para disponibilização do Helios em um servidor com a distribuição Linux Ubuntu (testado nas versões LTS 14.04, 16.04 e 18.04), embora já tenha sido feita instalação com sucesso no CentOS.

Para seguir esse tutorial é necessário tenha alguma experiência com administração de sistemas Linux (instalação de pacotes, configuração de serviços, etc.).

Personalizações feitas no Helios

Esse repositório contém as personalizações feitas no Helios. Ainda assim, buscará o sincronismo periódico com (sempre que possível e dentro do tempo possível) o projeto original do Ben Adida.

Personalizações e contribuições que fizemos que estão aqui e que não foram para o upstream:

• Tradução da interface para português
• Melhorias em algumas páginas e adequação para serem responsivas
• Criação de manuais para eleitores e para gestores de eleição
• Módulo de autenticação LDAP
• Módulo de autenticação Shibboleth
• Ajustes na página inicial e interface de administração para operação do Helios em ambiente Federado (Ex: Federação CAFe)
• Esse próprio arquivo com instruções para instalação do Helios 😄

Publicamos dois artigos sobre essas personalizações:

• CHAVES, S. A., MELLO, E. R. Adoção de modelo controle acesso baseado em atributos em sistema de votação online para ofertá-lo como um serviço de TIC federado. In: WGID - Workshop de Gestão de Identidade, 2015, Florianópolis. XV Simpósio Brasileiro em Segurança da Informação e de Sistemas Computacionais.
• CHAVES, S. A., MELLO, E. R. O uso de um sistema de votação on-line para escolha do conselho universitário In: WTE - Workshop de Tecnologia Eleitoral, 2014, Belo Horizonte. XIV Simpósio Brasileiro em Segurança da Informação e de Sistemas Computacionais

Instalação dos pacotes necessários (Ubuntu 18.04)

Softwares necessários

• python2.7
• apache2
• libapache2-mod-wsgi
• postgresql e postgresql-contrib
  • Aqui tem um bom tutorial de como instalar no Ubuntu 18.04
• build-essential
• git
• gettext
  • para uso das funcionalidade de compilação de mensagens traduzidas
• python-pip
• python-ldap python-dev libsasl2-dev libldap2-dev
  • para utilização do módulo de autenticação LDAP

Para instalação dos pacotes apresentados acima foi necessário editar o arquivo /etc/apt/sources.list e adicionar na seguinte linha a opção universe

deb http://archive.ubuntu.com/ubuntu bionic main universe

Depois é só fazer um sudo apt update e instalar os pacotes apresentados acima com o sudo apt install

A versão do Django utilizada nesta versão do Helios é a 1.8.18.

Preparação do ambiente para instalação do Helios

Recomendo que crie um usuário no sistema específico para o helios, por exemplo, usuário helios.

Configuração do banco de dados PostgreSQL

Editar o arquivo pg_hba.conf e inserir a linha:

Logo acima da linha:

local   all             all         peer

inserir a seguinte linha:

local   all              helios                         md5

A configuração acima corrige o seguinte erro:

Exception Type: 	OperationalError
Exception Value: 	
FATAL:  Peer authentication failed for user "helios"

Observação: Com a configuração padrão do postgresql só é possível se conectar nele a partir da máquina em que ele está instalado. Caso você queira se conectar na base com um cliente como o pgAdmin, sem abrir a configuração para conexão a partir de outra máquina, basta utilizar um túnel ssh. Editar ~/.ssh/config e inserir a entrada abaixo, substituindo os valores em letra maiúscula pelas configurações da sua instalação (e não esquecer que precisa haver uma conexão ssh aberta com o servidor do banco para que a configuração abaixo seja efetiva!):

Host NOMEDOHOST
User NOMEDOUSER
Hostname ENDERECODOHOST
Port PORTASSH
LocalForward PORTALOCAL 127.0.0.1:PORTAREMOTA

Todas as instruções abaixo devem ser executadas com o usuário helios e não com o superusuário (root).

Baixe o código fonte desse repositório:

git clone https://github.com/shirlei/helios-server.git

Não é obrigatório, mas é uma boa prática, criar um ambiente virtual python para a disponibilização do Helios, pois isso permite separar as dependências do projeto e não interferir em outros sistemas na mesma máquina.

Instale o virtualenv por meio do pip:

pip install virtualenv

Dentro do diretório onde o Helios foi baixado, execute o comando:

virtualenv venv

Isso criará um ambiente virtual python dentro do subdiretório chamado venv. Por fim, carregue o script venv/bin/activate para fazer uso do ambiente virtual:

source venv/bin/activate

Com o ambiente virtual ativado, instale os pacotes que estão listados no arquivo requirements.txt:

pip install -r requirements.txt

ATENÇÃO: Utilize o requirements.txt deste repositório para instalar o pacote django-auth-ldap e outros necessários para as personalizações que foram feitas no Helios. Lembrando também que apesar de se pretender manter este repositório atualizado com o do Ben Adida, não necessariamente vai ser simultâneo, então se você utilizar o dele, pode haver versões diferentes de pacotes.

Edite o arquivo settings.py e localize a seção databases. Adicione as informações para conexão no banco de dados, conforme o exemplo:

DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql_psycopg2',
'NAME': 'helios',
'USER': 'helios',
'HOST': 'localhost',
'PASSWORD': 'SENHADOHELIOS'
}}

Por fim, você precisará executar o script reset.sh (não faça como root) que fará a inicialização do esquema no banco de dados (criará as tabelas, etc.)

./reset.sh

Observação: Se tiver algum problema ao executar o script acima, provavelmente vai ser relacionado à configuração do PostgreSQL e, nesse caso, o Google é seu amigo. Porém, o erro mais comum é que você tenha executado o script como root e o postgres acuse que não há um usuário root. Recomendo criar um usuário que não seja root (por exemplo, helios) e usar o mesmo nome para usuário do banco. Ou executar os comandos contidos no script com o usuário adequado do banco.

Compilando arquivos com as traduções para português

A interface do Helios foi traduzida para o português e assim é necessário que compile os arquivos de tradução, caso queira usar a tradução que fizemos. Execute o seguinte comando a partir do diretório do Helios:

python manage.py compilemessages

Após a compilação, arquivos .mo devem ter sido gerados em locale/pt_BR/LC_MESSAGES

Observação: Para alterar alguma tradução é possível utilizar o aplicativo POEDIT, os mesmo editar diretamente os arquivos django.po e djangojs.po no editor de texto de sua preferência.

Se você adicionou alguma mensagem nova para ser traduzida e gostaria que fossem adicionadas aos arquivos de tradução, execute os comandos abaixo.

1. Para adicionar strings de arquivos python:

python manage.py makemessages -l pt_BR

2. Para adicionar strings de arquivos .js (os que passam pelo engine do Django):

python manage.py makemessages -d djangojs -l pt_BR --ignore=venv

Observação: Para a coleta de mensagens de arquivos .js, se você tiver criado o diretório de virtualenv relativo ao diretório do helios e chamado de por exemplo venv, você pode passar o parâmetro --ignore=venv conforme acima, para ignorar esse diretório.

Configuração dos módulos de autenticação

Você precisará habilitar em settings.py os módulos de autenticação que deseja. Por exemplo, poderia usar os módulos de autenticação do projeto original e permitir a autenticação de usuários por meio de contas Google, Facebook ou Twitter.

Na seção abaixo apresentamos as configurações necessárias para permitir a autenticação de usuários de uma base LDAP. Se não tiver um servidor LDAP e só queira testar o Helios, então talvez possa ser interessante tentar com os outros módulos de autenticação citados acima.

Autenticação em uma base LDAP

Habilite o módulo LDAP em settings.py:

AUTH_ENABLED_AUTH_SYSTEMS = get_from_env('AUTH_ENABLED_AUTH_SYSTEMS', 'ldap').split(",")

A documentação da biblioteca utilizada pode ser encontrada em http://pythonhosted.org/django-auth-ldap/example.html. Ela não é muito completa, mas as configurações principais estão no settings.py e são: AUTH_LDAP_SERVER_URI, AUTH_LDAP_BIND_PASSWORD, e AUTH_LDAP_USER_SEARCH.

As opções AUTH_LDAP_BIND_DN e AUTH_LDAP_BIND_PASSWORD deverão ter um valor configurado se o servidor LDAP exigir autenticação de usuário mesmo que seja para fazer consultas.

Observação: Você pode testar a conexão usando o próprio teste unitário do app de autenticação. Para tal, edite o arquivo helios_auth/tests.py, altere o usuário (euclid) e senha (password) que estão no teste usando o servidor de testes LDAP da ForumSys para um usuário e senha válidos no LDAP que você configurou no arquivo settings.py e execute python manage.py test helios_auth

Testando a instalação em ambiente de desenvolvimento

Ao executar o script reset.sh, você teve que criar um usuário de administração do django. Isso se deve ao fato de aplicação admin estar habilitada no arquivo settings.py (django.contrib.admin), pois iremos utilizá-la em algumas personalizações feitas para este fork do Helios.

Observação: você sempre pode criar um novo usuário para o django admin site executando o comando python manage.py createsuperuser

Se tudo estiver correto até aqui, agora você poderá executar o servidor web para desenvolvimento que é provido pelo próprio django. Use esse servidor somente para verificar se a instalação foi feita com sucesso, porém não use-o caso queira colocar o Helios no ambiente de produção.

Execute o seguinte comando:

python manage.py runserver 0.0.0.0:8000

Além disso, você precisa ter o celery rodando, pois algumas tarefas como processamento de arquivo de eleitores e envio de emails dependem dele.

Abra um outro terminal para deixar o celery em execução. Se você estiver usando o virtualenv, lembre-se de ativá-lo nesse novo terminal também.

celery -A helios worker -l info

Refrisando, essa parte é importante, pois é o celery responsável pelas tarefas de gravação dos votos, envio de emails, processamento do arquivo de eleitores, etc.

Feito isso, você pode acessar a URL http://endereco-do-seu-servidor-helios e se autenticar com algum usuário presente em sua base LDAP (ou um usuário de algum outro sistema de autenticação que tenha habilitado para o Helios).

Esse usuário não conseguirá criar eleições ainda, mas esse passo é necessário para que seja criada uma entrada para esse usuário na base. No próximo passo, Habilitando usuário com permissão de criar eleições,usaremos a aplicação admin do django para dar privilégio de gestor de eleição para esse usuário.

Habilitando usuário com permissão de gestor de eleições

Acesse a URL http://endereco-do-seu-servidor-helios/admin e se autentique com o usuário e senha de administração (você fez isso quando executou o script reset.sh).

Observação: Se você não lembra qual senha você criou, mas lembra o usuário, então é possível mudar a senha executando o comando python manage.py changepassword <usuario>

Na página de administração são apresentados os apps habilitados. Localize a opção Helios_Auth e clique em Users. Na página seguinte, escolha o usuário que você deseja editar (basta clicar somente o login do mesmo). Na página de edição, marque a opção Admin_p e salve.

Pronto! O usuário em questão recebeu o papel de gestor de eleição e será capaz de criar e gerenciar eleições com o Helios.

Atenção: só será possível dar o privilégio admin_p para usuários que se autenticaram previamente na aplicação Helios. Isso se deve à lógica de criação desse login, que é feita durante o login do usuário, caso ainda não exista.

Preparando ambiente de produção

Na seção anterior foi usado o servidor web de desenvolvimento provido pelo próprio Django (python manage.py runserver 0.0.0.0:8000). No entanto, ele é apenas para desenvolvimento e não deve ser usado em um ambiente de produção.

É possível trabalhar com diversos servidores web, porém no caso em questão optou-se pelo Apache.

Configuração apache

Módulos a serem habilitados, para a configuração exemplo:

sudo a2enmod rewrite
sudo a2enmod ssl

Para configurar o httpd.conf ou equivalente, siga as instruções em How to use Django with Apache and mod_wsgi.

A parte de servir os arquivos estáticos é a mais trabalhosa. Essa configuração é necessária porque no servidor de desenvolvimento o django serve esses arquivos, porém na produção, eles precisam ser configurados para serem servidos pelo servidor web.

Os arquivos estáticos não servidos pelo django são os "tradicionais": css, javascript e imagens, por exemplo.

No caso do Helios em particular, há módulos sendo servidos estaticamente (total ou parcial): o heliosbooth e o heliosverifier, os quais também precisam ser configurados.

Como o enfoque deste repositório está no desenvolvimento de novas funcionalidades e especialmente na personalização do Helios para o uso por entidades brasileiras, optou-se por uma solução menos elegante para os arquivos estáticos, mas que simplifica muito:

• fazer um link simbólico dos arquivos desses módulos e dos demais arquivos que precisam ser servidos estaticamente. E então configurar um alias para eles na configuração do apache, conforme os seguintes exemplos:

Alias /booth /`<path_to_site>`/sitestatic/booth

Alias /verifier /`<path_to_site>`/sitestatic/verifier

Além desses, todos os demais arquivos a serem servidos diretamente pelo apache, como os do módulo admin do django estão com links simbólicos no diretório sitestatic, que está sob controle do git.

Ou seja, se você clonar este projeto e utilizar a estrutura tal como está, não é necessário rodar o comando collectstatic, apenas configurar o apache para apontar para o diretório sitestatic contido neste projeto, conforme exemplo de configuração acima. Normalmente, para coletar esses arquivos, é preciso executar o comando collectstatic, conforme descrito em Collect static app.

Observações:

1. Neste repositório há um arquivo exemplo de configuração do Apache, o arquivo helios-ssl.conf. É um exemplo funcional para ambiente de homologação/dev com >Apache, mas é bastante similar à ambiente de produção, especialmente com relação aos alias necessários.

2. Em algumas instalações mais recentes usando Apache tem havido relatos de problemas (internal server erros, com logs com registro de segmentation fault ou >outros), para o qual se identificou que atualizando a biblioteca pyscopg2 (para psycopg2-2.8.5) e instalando a libpq-dev, resolvia. Obrigada ao pessoal do IF >Sudeste MG por compartilhar a solução.

Celery

Lembrando mais uma vez que o celery precisa estar em execução, pois ele é o enfileirador de tarefas, como a tarefa de envio de emails e a tarefa de registro de votos.

Em produção é interessante rodar o celery com múltiplos processos, para acelerar por exemplo envio de emails. Na prática, 5 processos em paralelo se mostrou suficiente.

Com a atualização para o Django 1.11.28, o celery foi atualizado para a versão 4.2.1, na qual ele não depende mais de uma biblioteca separada para trabalhar com o Django (no caso, era usada a django-celery). Agora o celery suporta o Django out of the box. Essa alteração fez com que não fosse mais necessária a biblioteca django-celery, assim como mudou o message broker utilizado para a fila de mensagens. Não é mais possível utilizar a própria base de dados para enfileirar as mensagens. Dentre as opções disponíveis estão o RabbitMQ e o Redis, por exemplo. Tanto para o RabbitMQ como para o Redis, é necessário instalar os pacotes necessários. Optou-se pelo uso do Redis e se você optar por ele também, no diretório docker há exemplo de configuração dele pra rodar supervisionado pelo supervisor, assim como no Dockerfile há indicação do pacote necessário (redis-server).

Também mudou a forma como o celery é executado. Como agora não é utilizado através de uma biblioteca separada para trabalhar com o django, bastar rodar direto o próprio celery, como por exemplo:

celery -A helios worker -l info --concurrency=5

Para que o resultado da execução das tarefas seja guardado no backend, adicionou-se o app django_celery_results e o django_celery_beat em INSTALLED_APPS.

O celery beat, agendador de tarefas periódicas, como limpar a tabela de resultados de execução de tarefas de tempos em tempos (o que pode crescer bastante), pode ser executado pelo comando celery, mas passando o parâmetro beat ao invér de worker:

celery -A helios beat -l info

No arquivo settings.py , colocou-se 60 dias como o prazo para apagar essas tarefas:

CELERY_RESULT_EXPIRES = 5184000 # 60 days

Se não desejar limpar da tabela de resultados das tarefas (django_celery_results_taskresult) dessa forma, basta não iniciar o celery beat. Conforme documentação, a tarefa de limpeza dessa tabela, considerando o prazo de expiração configurado, executa todo dia às 4 horas da manhã (GMT-3, então 1:00 da madrugada horário de Brasília). É possível ver esses resultados direto no banco na tabela django_celery_results_taskresult ou então via interface administrativa do django, na seção Celery Results -> Task results. A aplicação responsável por guardar esses resultados no backend do Django é a [django-celery-results)[https://docs.celeryproject.org/en/v4.2.1/django/first-steps-with-django.html#extensions].

Observação: Todos esses processos podem ser gerenciados com o supervisor. Você encontra exemplos de uso em docker/supervisor

Configurações Gerais:

• Para o ambiente de produção, em settings.py, configurar ALLOWED_HOSTS para o seu domínio. Exemplo:

  # set a value for production environment, alongside with debug set to false
  ALLOWED_HOSTS = get_from_env('ALLOWED_HOSTS', 'endereco-do-seu-servidor-helios').split(",")

• Para que qualquer usuário que se logar no sistema possa receber automaticamente o papel de gestor de eleição, e por consequência, receber o privilégio para criar e gerir eleições, edite o arquivo settings.py e deixe como False a opção HELIOS_ADMIN_ONLY

Outras personalizações feitas no Helios

Além do que já foi relatado na seção Personalizações feitas no Helios, detalhamos aqui algumas das personalizações realizadas.

Habilitar Interface de Administração do Django

O projeto original do Helios não vem com essa aplicação habilitada. A interface de administração automática facilita algumas atividades de gerenciamento dentro da organização, como por exemplo dar permissão de criação de eleição para um usuário. Você encontra diversas referências a essa interface ao longo deste tutorial.

Listar eleições na página inicial do Helios

Nessa personalização, as eleições que são listadas na página inicial são as que são explicitamente marcadas dessa forma via interface de administração do django (o módulo /admin que foi adicionado neste fork).

Se você quiser que uma eleição seja listada na página inicial do Helios, faça:

• Na página de administração do Django, localize a opção Helios e clique em Elections.
• Na página seguinte, clique no nome da eleição que você gostaria que fosse listada na página pública e na tela de edição, marque a opção Featured p e salve.

Autenticação federada via shibboleth

Para a utilização federada do Helios, diversas personalizações foram efetuadas tanto na página pública, quando na parte de gerenciamento de eleições. Essas personalizações estão hoje no ramo helios_shibboleth e somente no repositório https://github.com/shirlei/helios-server.

Obs.: como esse branch não foi integrado ao branch principal, e desde a última versão estável várias atualizações, incluindo versões de software foram realizadas no branch principal(master), o branch helios_shibboleth precisará de trabalho de merge e resolução de possíveis conflitos.

Configuração da autenticação com o módulo apache shibboleth2

Além do módulo de autenticação LDAP, também foi desenvolvido um módulo de autenticação considerando o módulo shibboleth2 para o Apache. Nesse caso, o Helios funciona como um Provedor de Serviço (Service Provider - SP).

Se o SP estiver na federação, então qualquer usuário autenticado em um IdP da federação será capaz de acessar o Helios. Agora se o SP não ficar na federação, então é possível estabelecer confiança mútua entre o SP e o IdP de sua instituição. Dessa forma, somente os usuários oriundos do IdP de sua instituição poderão acessar o SP Helios

Para utilizar essa funcionalidade, deve-se instalar o módulo apache shibb (funcionalidade testada com libapache2-mod-shib2) do servidor que vai servir o SP Helios e efetuar as configurações necessárias do shibboleth. Essas configurações incluem por exemplo o estabelecimento de confiança com o IdP, obtenção de metadados do IdP, envio de metadados do SP para o IdP, etc. Um bom ponto de partida, caso a instituição não costume configurar SPs shibboleth, é pesquisar por tutoriais que auxiliem na configuração de um SP.

Além disso, o módulo de autenticação shibboleth deve ser habilitado no arquivo settings.py e torná-lo padrão, para que a interface multi-instituição seja utilizada:

AUTH_ENABLED_AUTH_SYSTEMS = get_from_env('AUTH_ENABLED_AUTH_SYSTEMS', 'shibboleth').split(",")

AUTH_DEFAULT_AUTH_SYSTEM = get_from_env('AUTH_DEFAULT_AUTH_SYSTEM', 'shibboleth')

Deve-se também configurar os demais atributos em settings.py, na seção #Shibboleth auth settings.

Observação: As configurações aqui indicadas supõe que o provedor de serviço (apache, módulo shibboleth e demais configurações) está configurado e funcional.

Habilitando instituições da federação para usarem o serviço Helios

Toda instituição a utilizar o Helios federado deve ser previamente cadastrada. Esse cadastro é feito na parte administrativa do Django. Acesse http://endereco-do-seu-servidor-helios/admin, procure por HeliosInstitution e clique em Institutions e então em Adicionar Institution. Forneça os dados necessários e clique em salvar.

Toda instituição deve ter pelo menos um usuário com o papel de administrador da instituição. Para adicionar esse papel a um usuário acesse o aplicativo admin do Django e:

1. Em HeliosInstitution, clique em Institution user profiles e depois em Adicionar institution user profiles
2. Se o usuário a ser cadastrado já se conectou alguma vez via federação, deve aparecer no campo Helios user. Se não, deixe em branco.
3. No campo django user, é necessário adicionar um novo usuário. Clique no ícone + e informe no campo usuário o email do administrador e em permissões selecione Institution Admin. Clique em salvar.
4. No campo institution, selecione a instituição previamente criada.
5. Em e-mail, informe o e-mail do administrador. Se desejar, informe a data de expiração desse usuário. Deixe o campo active desmarcado (será marcado quando o usuário se conectar no serviço pela primeira vez).

Usando docker para desenvolvimento

O objetivo desta seção é repassar as informações necessárias para subir containeres docker para ambiente de desenvolvimento. Alguma familiaridade com o uso do docker é necessária, para ajustes eventuais de acordo com a sua realidade.

Os arquivos relacionados ao docker são os seguintes:

• docker-compose.yml

Execute docker-compose up -d, por exemplo, para iniciar os containeres. Imagens inexistentes serão baixadas (postgres e ubuntu:18.04) e os builds necessários serão realizados, assim como a inicialização dos containers. Se você já executou essa operação e quer forçcar fazer build novamente, pode por exemplo rodar o mesmo comando, adicionando também o parâmetro --build Como a intenção deste tutorial não é ensinar a usar o docker, por favor verifique a documentação para outras informações e detalhes.

Ao término, você deve ter dois containeres rodando, um com o postgres e outro com o helios e dependências. O container do helios vai possuir tanto a aplicação Django helios, como também Apache e celery rodando. Não foram feitas maiores separações pelo entendimento de que para brevidade de disponilibidade de desenvolvimento não há necessidade. Além disso, como geralmente há muitas dúvidas com configurações de Apache, esse container já vai estar também simulando uma configuração de ambiente de produção em uma VM, por exemplo, com as devidas configurações de Apache e supervisor para controle tanto do Apache como do celery.

Você pode logar no container e verificar as configurações e também pode, supondo que nenhuma modificação foi feita nos arquivos de build, acessar tanto localhost:8000 para o ambiente de dev, como https://localhost , no navegador, para acesso via Apache.

Obs.: alterações que você faça localmente no código fonte (veja que o código fonte foi montado como um volume), se refletirão 'automaticamente' apenas para localhost:8000 (ou outra porta que você tenha configurado), que é onde está rodando o servidor de desenvolvimento. Para refletir para o Apache e celery você precisa reiniciar o supervidor ou o container.

• docker folder
  • Dockerfile Arquivo de build da imagem a ser usada pelo container do serviço helios.
  • Arquivos supervisor Arquivos que serão carregados na imagem do helios, para utilização pelo gerenciador de processos supervisor
  • Arquivos Apache2 Arquivo de configuração para o helios ser servido pelo Apache. Os arquivos de certificados não são válidos, você deve gerar um autoassinado para testes em desenvolvimento, como uma ferramenta como o openssl ou usar algum que você já possua para esse propósito. Basta substituir os arquivos.
  • docker-entrypoint.sh Script com as execuções necessárias para inicialização da aplicação helios pelo Django, especialmente, além da inicialização do supervisor.
  • Arquivos postgres Script de inicialização da base de dados a ser usada pelo helios.

Antes de executar o docker-compose, você deve criar um arquivo .env na raiz deste projeto, contendo as seguintes variáveis de ambiente:

    DEBUG=1
    ALLOWED_HOSTS='localhost,192.168.15.7'
    SECRET_KEY='^m-&-5eq6bu))ovhgzuus4g)#v-&m&0d8qaf)f2*z9av!t!7+('
    POSTGRES_PASSWORD=postgres
    DB_NAME=helios
    DB_PWD=helios
    DB_USER=helios
    POSTGRES_HOST=db
    POSTGRES_PORT=5432
    EMAIL_USE_TLS=1
    EMAIL_HOST=<your smtp server>
    EMAIL_PORT=587
    EMAIL_HOST_USER=<email a ser usado como remetente>
    EMAIL_HOST_PASSWORD=<a senha do email fornecido em EMAIL_HOST_USER>
    URL_HOST=http://localhost
    SECURE_URL_HOST=https://localhost
    DJANGO_SUPERUSER_USERNAME=admin
    DJANGO_SUPERUSER_EMAIL=<adicione um email valido>
    DJANGO_SUPERUSER_PASSWORD=admin
    GROUP_ID=1000
    USER_ID=1000
    CELERY_BROKER_URL=redis://127.0.0.1:6379

DEBUG=1 indica que o django está em modo DEBUG, exibindo por exemplos mensagens de erro da aplicação com detalhamento no navegador. Use apenas em desenvolvimento!

Em ALLOWED_HOSTS indique o(s) nomes de hosts/domínios nos quais o Django pode servir o Helios. Obrigatório configurar se DEBUG configurada pra false (DEBUG=0).

Para a SECRET_KEY, troque os valores conforme orientação em Alguns lembretes finais cruciais para o ambiente de produção

DB_NAME, DB_PWD e DB_USER devem conferir com nome do banco, usuário e senha fornecidos no arquivo init.sql para o container do postgres.

POSTGRES_HOST e POSTGRES_PORT devem conferir com o nome do serviço e porta definidos no docker-compose.yml para o postgres.

As variáveis EMAIL_* devem ser preenchidas com o serviço de email a ser usado para as atividades de envio de email pelo Helios.

URL_HOST indica endereço sem considerar HTTPS e SECURE_URL_HOST indica o endereço a ser usado quando HTTPS configurado.

Observação: Para o caso de desenvolvimento, é importante indicar a porta na qual o servidor de desenvolvimento foi iniciado (no caso do nosso docker-compose.yml, a porta 8000), para que a navegação se direcione para essa porta e possa ser utilizada a funcionalidade de reload automático para mudanças de código.

DJANGO_SUPERUSER_USERNAME, DJANGO_SUPERUSER_EMAIL e DJANGO_SUPERUSER_PASSWORD são as informações para criar um usuário admin (você pode configurar outro username no arquivo .env, assim como outra senha!), aquele que você normalmente criaria executando no shell o comando python manage.py createsuperuser. Esse usuário é o usuário do app django admin site, que foi habilitado para essa personalização do helios. Com ele você acessa, por exemplo, http://localhost:8000/admin e consegue executar algumas operações administrativas, como habilitar um usuário que já logou previamente no helios para ser gestor de eleições ou então visualizar lista de usuários do helios. Não confundir com usuário gestor de eleição do helios! Esse usuário não é usuário que consegue logar na aplicação Helios. A aplicação Helios depende de módulo de autenticação próprio habilitado, dentre os disponíveis (Google ou Ldap, por exemplo).

O GROUP_ID e USER_ID você pode usar o do usuário local, no host em que você vai rodar o docker-compose, para evitar problemas de permissão de diretórios. Por exemplo, o teu usuário local tem o uid 1000 e você montou o diretório local onde baixou o helios para um volume do docker, no qual o usuário criado tem outro uid. Importante: se você não quiser fornecer esse valor, remova o parâmetro -g e -u do comando RUN groupadd -r -g 1000 helios && useradd -r -g helios -u 1000 helios no Dockerfile da imagem.

CELERY_BROKER_URL indica o endereço e credenciais de acesso ao serviço de message broker, no caso, o Redis.

Importante destacar que para variáveis que não sejam informadas, será utilizado o valor padrão definido em settings.py. Você também pode configurar assim outras variáveis do settings.py que achar necessário, seguindo o mesmo padrão.

Observação: Todos os valores de configuração e escolhas de organização de serviços e containeres foram feitas pensando em ambiente de desenvolvimento local, para facilitar configurar o ambiente especialmente considerando questões de versões de software (como o Python2, por exemplo). Questões de segurança e até melhores práticas de separação de serviços por containers e etc não estão aqui consideradas!

Alguns lembretes finais cruciais para o ambiente de produção

• Em settings.py alterar de True para False o valor da constante DEBUG
• Alterar obrigatoriamente o valor do SECRET_KEY. Há ferramentas na web pra isso, como a disponível em http://www.miniwebtool.com/django-secret-key-generator/
• Conforme indicado no settings.py, não se deve alterar o valor da opção SECURE_URL_HOST após você já ter o sistema em produção, com eleições criadas (em andamento ou finalizadas), pois caso contrário a URL para depósito da cédula se tornará inválida.