O Painel AVA é um middleware integrador entre SUAP e Moodle, além disso, também tem um dashboard com todos os cursos e inscrições que integrou, desta forma cada usuário tem acesso aos cursos/diários em que está inscrito sem precisar procurar em vários Moodles.
Neste projeto usamos o Docker e o Docker Compose Plugin (não o docker-compose 😎). O setup foi todo testado usando o Linux e Mac OS.
Os containeres terão o prefixo
ism-, que é um acrônimo para "Integrador Suap Moodle".
Como desenvolvedor - no local_settings.py do SUAP configure as variáveis (MOODLE_SYNC_URL e MOODLE_SYNC_TOKEN), no Painel AVA configure o mesmo token que você configurou no SUAP. Para cada Moodle a ser integrado instale o plugin auth_suap e cadastre no Painel AVA como um "Ambiente".
Como usuário - no SUAP, o secretário acadêmico autoriza cada diário a ser integrado ao Moodle, na página do diário no SUAP o professor clica em "Sincronizar" e a mágica se faz, ou seja, o SUAP envia para o Painel AVA que, com base na sigla do campus, decide para qual Moodle encaminhar a requisição de integração, o Moodle cadastra/atualiza as categorias (Campus, Diário, Semestre, Turma), o curso, os pólos como grupos do curso e os professores e alunos, então inscreve os professores (Formador e Tutor) e os alunos, por fim, arrola os alunos nos grupos de seus respectivos pólos.
As variáveis de ambiente no SUAP têm as seguintes definições:
MOODLE_SYNC_URL- URL do Painel AVAMOODLE_SYNC_TOKEN- o token deve ser o mesmo que você vai configurar ao cadastrar o SUAP no Painel AVA, é usada para autenticação do SUAP, guarde segredo desta chave.
Crie um arquivo .env parecido com o que se segue:
COMPOSE_PROJECT_NAME=avaNa mesma pasta, crie um arquivo docker-compose.yml parecido com o que se segue:
services:
cache:
image: redis:7.2-alpine
healthcheck:
test: ["CMD", "redis-cli", "ping"]
interval: 3s
timeout: 3s
retries: 3
start_period: 10s
db:
image: postgres:16-alpine
environment:
- POSTGRES_USER=postgres
- POSTGRES_PASSWORD=changeme
volumes:
- "./volumes/db_data:/var/lib/postgresql/data"
healthcheck:
test: ["CMD", "pg_isready", "-U", "postgres"]
interval: 3s
timeout: 3s
retries: 3
start_period: 10s
painel:
image: ctezlifrn/avapainel:1.0.64
ports:
- 80:8000
environment:
- POSTGRES_HOST=db
- POSTGRES_USER=postgres
- POSTGRES_PASSWORD=changeme
- DJANGO_DEBUG=False
- DJANGO_ALLOWED_HOSTS=ava.yourhost.edu.br
# 1. Crie uma chave, em qualquer ferramenta, de no mímino 50 caracteres
- DJANGO_SECRET_KEY=changeme
# 2. Crie um project no Sentr.io e pegue a DNS
# SENTRY_DNS=https://[email protected]/id
# 3. Crie uma "Aplicações OAUTH2" no SUAP e pegue o client_id e o client_secret
- OAUTH_CLIENT_ID=changeme
- OAUTH_CLIENT_SECRET=changeme
- OAUTH_BASE_URL=https://suap.yourhost.edu.br
- OAUTH_REDIRECT_URI=https://ava.yourhost.edu.br/painel/authenticate/
# 4. Atribua o token de integração do SUAP
- SUAP_INTEGRADOR_KEY=changeme
# 5. Se cadastre no https://userway.org/ e registre o token da conta
- SHOW_USERWAY=True
- USERWAY_ACCOUNT=changeme
- SHOW_VLIBRAS=True
volumes:
- "./volumes/painel_media:/var/media"
- "./volumes/painel_static:/var/static"
depends_on:
cache:
condition: service_healthy
db:
condition: service_healthy
healthcheck:
test:
[
"CMD-SHELL",
"curl --silent --fail https://ava.yourhost.edu.br/painel/health/ | grep 'Database: OK' || exit 1",
]
interval: 3s
timeout: 1s
start_period: 1s
retries: 30O acesso ao administrativo usará o SUAP, o primeiro usuário a acessar será tornado superuser.
Suba os serviços.
docker compose upAcesse o https://ava.yourhost.edu.br/painel/admin/, cadastre os AVA em Ambientes, o token que você gerar para cada ambiente deverá ser utilizado no plugin do local_suap que você instalar em cada AVA.
Este docker-compose assume que você não tenha aplicações rodando na porta 80, ou seja, pare o serviço que está na porta 80 ou faça as configurações necessárias vocês mesmo. O script _/deploy já cria automaticamente uma entrada no /etc/hosts, caso não exista, que aponta para localhost. Isso é necessário para simplificar o cenário de desenvolvimento local.
# Baixe o projeto na pasta de exemplo (se for outra, basta que altere os scripts)
mkdir -p ~/projetos/IFRN/ava/integracao
git clone [email protected]:cte-zl-ifrn/painel__ava.git ~/projetos/IFRN/ava/integracao/painel_ava
cd ~/projetos/IFRN/ava/integracao/painel_ava
# Configura o teu /etc/hosts para atender por http://ava
./painel env setup
# Configure o SUAP, os Moodles e altere as variáveis de ambiente para seu ambiente local
./painel env deploy
# Se você usa o VSCode
code painel__ava.code-workspaceO Painel estará disponível em http://ava, o primeiro usuário a acessar será declarado como superusuário e poderá fazer tudo no sistema.
Caso você deseje fazer debug do Painel AVA, tente:
./painel app down
./painel app debugecho 'PATH=$PATH:~/projetos/IFRN/ava/integracao/painel_ava' >> ~/.bashrc
source ~/.bashrcecho 'PATH=$PATH:~/projetos/IFRN/ava/integracao/painel_ava' >> ~/.zshrc
source ~/.zshrc- É obrigatório ao menos um dos escopos
identificacaoouemail, os quais retornam os atributos:identificacao- NUMÉRICO - é o IFid do usuário, no caso: matrícula para alunos ou servidores e CPF para demais colaboradoresnome_social- ALFANUMÉRICO - nome social, este é o informado pelo indivíduo, não se trata de apelido, mas sim de nome social, conforme legislaçãonome_usual- ALFANUMÉRICO - nome usual, escolhido pelo indivíduo na interface do SUAPnome_registro- ALFANUMÉRICO - nome civil, este é conforme está no registro civil do indivíduonome- ALFANUMÉRICO - nome completo, para compatibilidade com APIs que não sabem tratar nome e sobrenome separadosprimeiro_nome- ALFANUMÉRICO - primeiro nome, para compatibilidade com APIs que não sabem tratar nome e sobrenome juntosultimo_nome- ALFANUMÉRICO - último nome, para compatibilidade com APIs que não sabem tratar nome e sobrenome juntoscampus- ALFANUMÉRICO - sigla do campus do aluno ou servidor, caso exista, não se aplica aos demais colaboradoresemail_preferencial- EMAIL - email preferencial para comunicação, caso exista, para servidores é o mesmo que oemail, para alunos e demais colaboradoresemail_secundario, salvo se a instituição tiver criado um mecanismo que permita ao usuário escolher qual é seu email preferencial.email- EMAIL - email do servidor, caso exista, apenas para servidoresemail_secundario- EMAIL - email pessoal, caso exista, o mesmo usado para recuperação de senha, para todosemail_google_classroom- EMAIL - email do Google Suite, caso exista, apenas para alunos e servidoresemail_academico- EMAIL - email da Microsoft 365, caso exista, apenas para alunos e servidoresfoto- URL - URL da foto no SUAP, assim poderá ser usada a mesma foto em todos os ambientes
- Já o escopo
documentos_pessoaisretorna os atributos:cpf- NUMÉRICO - CPF do indivíduo, útil para os casos de integração com gov.br ou para informar que possui outras contas no sistema. Poderá ser necessário novo login para trocar de conta.data_de_nascimento- DATA - data de nascimento, ajuda a identificar indivíduos menos de idade, entre outrossexo- ALFANUMÉRICO - sexo- No futuro poderá retornar dados de necessidades especiais, assim os sistemas já adaptarão as interfaces a estas necessidades.
O design ficará como os designs web e mobile.
- suap sync (local)
- importar as inscrições (alunos e professores) dos diários
- exportar as presenças dos alunos
- exportar as notas dos alunos
- suap attendances (block)
- configurar o modelo de cálculo de presenças
- permitir que os professores visualizem as presenças
- permitir que os alunos visualizem as presenças
- suap auth (auth)
- autênticar usando o oauth do SUAP
- auto inscrever os alunos ao fazer login
feat:novas funcionalidades.fix:correção de bugs.refactor:refatoração ou performances (sem impacto em lógica).style:estilo ou formatação de código (sem impacto em lógica).test:testes.doc:documentação no código ou do repositório.env:CI/CD ou settings.build:build ou dependências.