<<<<<<< HEAD
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? Use the template at the bottom!
- Create or upload files
- Add files using the command line or push an existing Git repository with the following command:
cd existing_repo
git remote add origin http://git.devops.softagon.io/ieducar/i-diario-docker.git
git branch -M master
git push -uf origin master
- Invite team members and collaborators
- Create a new merge request
- Automatically close issues from merge requests
- Enable merge request approvals
- Automatically merge when pipeline succeeds
Use the built-in continuous integration in GitLab.
- Get started with GitLab CI/CD
- Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)
- Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy
- Use pull-based deployments for improved Kubernetes management
- Set up protected environments
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to makeareadme.com for this template.
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
Choose a self-explaining name for your project.
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
If you have ideas for releases in the future, it is a good idea to list them in the README.
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
Show your appreciation to those who have contributed to the project.
For open source projects, say how it is licensed.
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
Portal do professor integrado com o software livre i-Educar.
Acreditamos que o sucesso do projeto depende diretamente da interação clara e objetiva entre os membros da Comunidade. Por isso, estamos definindo algumas políticas para que estas interações nos ajudem a crescer juntos! Você pode consultar algumas destas boas práticas em nosso código de conduta.
Além disso, gostamos de meios de comunicação assíncrona, onde não há necessidade de respostas em tempo real. Isso facilita a produtividade individual dos colaboradores do projeto.
| Canal de comunicação | Objetivos |
|---|---|
| Fórum | - Tirar dúvidas - Discussões de como instalar a plataforma - Discussões de como usar funcionalidades - Suporte entre membros de comunidade - FAQ da comunidade (sobre o produto e funcionalidades) |
| Issues do Github | - Sugestão de novas funcionalidades - Reportar bugs - Discussões técnicas |
| Telegram | - Comunicar novidades sobre o projeto - Movimentar a comunidade - Falar tópicos que não demandem discussões profundas |
Qualquer outro grupo de discussão não é reconhecido oficialmente pela comunidade i-Educar e não terá suporte da Portabilis - mantenedora do projeto.
Há duas formas de fazer a instalação:
ATENÇÃO: Essa forma de instação tem o objetivo de facilitar demonstrações e desenvolvimento. Não é recomendado para ambientes de produção!
Para instalar o projeto execute todos os passos abaixo.
- Clone o repositório:
git clone https://github.com/portabilis/i-diario.git && cd i-diario- Faça o build das imagens Docker utilizadas no projeto (pode levar alguns minutos) e inicie os containers da aplicação:
docker-compose up -d --build-
Use o comando
docker-compose logs -f apppara acompanhar o log da aplicação. -
Aguarde a instalação finalizar até algo similar aparecer na tela:
idiario | => Ctrl-C to shutdown server
idiario | Puma starting in single mode...
idiario | * Version 4.3.1 (ruby 2.3.7-p456), codename: Mysterious Traveller
idiario | * Min threads: 0, max threads: 16
idiario | * Environment: development
idiario | * Listening on tcp://0.0.0.0:3000
idiario | Use Ctrl-C to stop
Você poderá acessar o i-Diário na URL http://localhost:3000 com o login admin e a senha
123456789.
Você pode criar um arquivo docker-compose.override.yml para personalizar sua instalação do i-Diário, mudando as portas
dos serviços ou o mapeamento dos volumes extras para a aplicação.
- Instale o Ruby 2.4.10 (recomendamos uso de um gerenciador de versões como Rbenv ou Rvm)
- Instale o Postgres e faça a configuração em
database.yml - Instale a biblioteca
libpq-dev
sudo apt install libpq-dev- Instale Redis
sudo apt install redis-server- Instale a gem Bundler:
gem install bundler -v '1.17.3'- Instale as gems:
bundle install- Instale as dependencias do projeto
yarn install- Crie e configure o arquivo
config/secrets.ymlconforme o exemplo:
development:
secret_key_base: CHAVE_SECRETA
SMTP_ADDRESS: SMTP_ADDRESS
SMTP_PORT: SMTP_PORT
SMTP_DOMAIN: SMTP_DOMAIN
SMTP_USER_NAME: SMTP_USER_NAME
SMTP_PASSWORD: SMTP_PASSWORD
NO_REPLY_ADDRESS: NO_REPLY_ADDRESS
EMAIL_SKIP_DOMAINS: EMAIL_SKIP_DOMAINS
STUDENT_DOMAIN: STUDENT_DOMAINNota: Você pode gerar uma chave secreta usando o comando bundle exec rake secret
Nota: Use EMAIL_SKIP_DOMAINS para informar domínios (separadas por virgula e sem espaço) para os quais não quer
que o sistema faça envio de emails
Nota: Use STUDENT_DOMAIN para informar o domínio que vai ser usado para criar as contas de usuarios dos alunos na sincronização. Se não for informado, o checkbox que permite essa funcionalidade na tela de configurações não vai ser apresentado
- Crie o banco de dados:
bundle exec rake db:create
bundle exec rake db:migrate- Crie as páginas de erro se baseando nas padrões:
cp public/404.html.sample public/404.html
cp public/500.html.sample public/500.html- Crie uma entidade:
bundle exec rake entity:setup NAME=prefeitura DOMAIN=localhost DATABASE=prefeitura_diario- Configure os uploads de arquivos
O i-Diário tem alguns uploads de arquivos, como anexos e foto de perfil. Foi utilizado as gems Carrierwave com carrierwave-aws.
Hoje, se não há configuração para usar a AWS S3, irá salvar os arquivos localmente.
Para usar AWS S3, basta colocar no secrets as seguintes chaves, alterando para valores reais:
AWS_ACCESS_KEY_ID: 'xxx'
AWS_SECRET_ACCESS_KEY: 'xxx'
AWS_REGION: 'us-east-1'
AWS_BUCKET: 'bucket_name'Se quiser customizar para onde vai o upload de documentos, caso queira mandar para um lugar diferente das imagens pode usar as secrets abaixo:
DOC_UPLOADER_AWS_ACCESS_KEY_ID: 'xxx'
DOC_UPLOADER_AWS_SECRET_ACCESS_KEY: 'xxx'
DOC_UPLOADER_AWS_REGION: 'us-east-1'
DOC_UPLOADER_AWS_BUCKET: 'bucket_name'Caso você queira usar outro meio de fazer upload de arquivos, recomendamos dar uma olhada no Fog.
O Fog trabalha com essas opções.
Para adicionar o fog, crie o arquivo Gemfile.plugins, que irá ter gems customizadas, e coloque a gem
gem 'fog', '~>1.42.0'.
Uma vez adicionada a gem fog, basta criar um arquivo de configuração em config/custom_carrierwave.rb
e fazer os ajustes para funcionar. Leia atentamente a documentação do carrierwave antes de fazer isso.
- Redirecionar os relatórios para outro servidor (opcional)
REPORTS_SERVER_IP: xx.xx.xx.xx
REPORTS_SERVER_USERNAME: username
REPORTS_SERVER_DIR: /var/www/relatorios_idiarioNota: REPORTS_SERVER_DIR deve estar dentro da pasta publica do seu servidor
- Inicie o servidor:
bundle exec rails server- Inicie os processos do sidekiq
- Antes de realizar o primeiro acesso, crie um usuário administrador:
bundle exec rails console- Crie o usuário administrador, substitua as informações que deseje:
Entity.last.using_connection {
User.create!(
email: '[email protected]',
password: '123456789',
password_confirmation: '123456789',
status: 'active',
kind: 'employee',
admin: true,
first_name: 'Admin'
)
}Agora você poderá acessar o i-Diário na URL http://localhost:3000 com as credenciais fornecidas no passo anterior.
- Para fazer a sincronização entre i-Educar e i-Diário é necessário estar com o Sidekiq rodando;
- Acessar Configurações > Api de Integraçao e configurar os dados do sincronismo
- Acessar Configurações > Unidades e clicar em Sincronizar
- Acessar Calendário letivo, clicar em Sincronizar e configurar os calendários
- Acessar Configurações > Api de Integração
- Existem dois botões nessa tela:
- Sincronizar: Ao clicar nesse botão, será verificado a ultima data de sincronização e somente vai sincronizar os dados inseridos/atualizados/deletados após essa data.
- Sincronização completa: Esse botão apenas aparece para o usuário administrador e ao clicar nesse botão, não vai fazer a verificação de data, sincronizando todos os dados de todos os anos.
- Existem dois botões nessa tela:
Nota: Após esses primeiros passos, recomendamos que a sincronização rode pelo menos diariamente para manter o i-Diário atualizado com o i-Educar
É a ferramenta usada para rodar comandos em background, sem travar o sistema enquanto ele é usado.
- Processo 1 (Responsável pela sincronização com o i-educar)
bundle exec sidekiq -q synchronizer_enqueue_next_job -c 1 -d --logfile log/sidekiq.log- Processo 2 (Responsável pelos outros jobs)
bundle exec sidekiq -c 10 -d --logfile log/sidekiq.logSempre que for fazer deploy, deve-se parar o sidekiq e depois reiniciá-lo com os comandos acima.
ps -ef | grep sidekiq | grep -v grep | awk '{print $2}' | xargs kill -TERM && sleep 20Conhece mais sobre o sidekiq aqui.
Se o município configurado tem muitos envios de faltas e notas para o i-educar, é possível iniciar vários processos para aumentar a concorrência.
No exemplo abaixo, estamos rodando dois processos do sidekiq.
bundle exec sidekiq -q exam_posting_1 -c 1 -d --logfile log/sidekiq_exam_posting_1.logbundle exec sidekiq -q exam_posting_2 -c 1 -d --logfile log/sidekiq_exam_posting_1.logPara funcionar, é necessário adicionar no arquivo config/secrets.yml as filas
usadas, separadas por virgula e sem espaço:
production:
EXAM_POSTING_QUEUES: 'exam_posting_1,exam_posting_2'Assim ele vai escolher randomicamente qual a fila irá usar, diminuindo o gargalo no servidor.
Deve-se tomar cuidado pois quanto mais concorrência, mais irá exigir do i-educar.
Foi decidido usar a abordagem de vários workers com apenas um de concorrência para diminuir a carga no i-educar. Então se um professor envia faltas e notas para o i-educar, ele irá usar uma fila só sequencial. Se outro professor for enviar, ele irá rodar em outra fila (se o random jogar para essa fila.)
# (Docker) docker-compose exec app RAILS_ENV=test bundle exec rake db:create
RAILS_ENV=test bundle exec rake db:create
# (Docker) docker-compose exec app RAILS_ENV=test bundle exec rake db:migrate
RAILS_ENV=test bundle exec rake db:migrate# (Docker) docker-compose exec app bin/rspec spec
bin/rspec specNessa atualização a sincronização entre i-Educar e i-Diário foi completamente reestruturada e com isso o i-Diário passa a ter dependência da versão 2.1.18 do i-Educar.
Para o upgrade é necessário atualizar o i-Diário para a versão 1.1.0.
- Executar as migrations:
# (Docker) docker-compose exec app bundle exec rake db:migrate
bundle exec rake db:migrate- Executar a rake task que irá fazer a atualização do banco de dados e executar a sincronização completa em todas as entidades:
# (Docker) docker-compose exec app bundle exec rake upgrade:versions:1_1_0
bundle exec rake upgrade:versions:1_1_0c5f9d77 (Comeco do dockerfile imagem softagon)