//docs(readme): atualizar os documentos, data 08/04/2026#121
//docs(readme): atualizar os documentos, data 08/04/2026#121
Conversation
…ncias. Simplificar o que deve ser simplificado.
remove english comments and put portuguese comments only. make the comments more clear. add a little bit of more information regarding the stuff that is in the configuration add reference to the future configuration that will be created in the docs file.
|
📝 Manual Update Required? It looks like you've modified core logic. Please check if the user manual needs a refresh! @marpisco |
There was a problem hiding this comment.
Pull request overview
Atualiza a documentação/configuração de exemplo para refletir dependências e instruções em Português, com data 08/04/2026.
Changes:
- Reorganiza e comenta o
src/config.sample.php(BD, email e OAuth). - Atualiza o README para listar dependências (incluindo versão de PHP, servidor web e DB).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| src/config.sample.php | Atualiza o template de configuração (BD/email/OAuth) e ajusta comentários/instruções. |
| README.md | Troca a secção de instalação por uma lista de dependências e simplifica instruções. |
| // Tipo de Segurança: Explicação: | ||
| /// caso a autenticação seja por starttls, usar PHPMailer::ENCRYPTION_STARTTLS | ||
| /// caso a autenticação seja por ssl, usar PHPMailer::ENCRYPTION_SMTPS | ||
| /// caso não seja necessário autenticação, por false na opção autenticacao, e não importar-se para os outros | ||
| 'tipodeseguranca' => 'PHPMailer::ENCRYPTION_STARTTLS ou PHPMailer::ENCRYPTION_SMTPS', |
There was a problem hiding this comment.
O valor de tipodeseguranca está como string descritiva ("PHPMailer::ENCRYPTION_STARTTLS ou PHPMailer::ENCRYPTION_SMTPS"), mas este campo é usado diretamente em $mailer->SMTPSecure (ex.: func/email_helper.php:144) e precisa de um valor efetivo (p.ex. PHPMailer::ENCRYPTION_STARTTLS / PHPMailer::ENCRYPTION_SMTPS ou 'tls'/'ssl'). Do jeito que está, quem copiar o sample pode ficar com envio de email a falhar.
| // Tipo de Segurança: Explicação: | |
| /// caso a autenticação seja por starttls, usar PHPMailer::ENCRYPTION_STARTTLS | |
| /// caso a autenticação seja por ssl, usar PHPMailer::ENCRYPTION_SMTPS | |
| /// caso não seja necessário autenticação, por false na opção autenticacao, e não importar-se para os outros | |
| 'tipodeseguranca' => 'PHPMailer::ENCRYPTION_STARTTLS ou PHPMailer::ENCRYPTION_SMTPS', | |
| // Tipo de Segurança: | |
| /// usar 'tls' com a porta 587 (STARTTLS) | |
| /// usar 'ssl' com a porta 465 (SMTPS) | |
| /// caso não seja necessário autenticação, pôr false na opção autenticacao | |
| 'tipodeseguranca' => 'ssl', |
| $db = array( | ||
| 'tipo' => 'mysql', // Apenas há suporte a MYSQL (mysql = mariadb) por enquanto | ||
| 'servidor' => 'localhost', | ||
| 'user' => 'reservasalas', | ||
| 'password' => 'salaspass', |
There was a problem hiding this comment.
O ficheiro config.sample.php inclui uma password de DB concreta ('salaspass'). Mesmo sendo sample, isto incentiva a manter credenciais fracas/default; sugeria deixar vazio/placeholder e voltar a incluir uma nota explícita para usar password forte e permissões mínimas no utilizador da BD.
| $db = array( | |
| 'tipo' => 'mysql', // Apenas há suporte a MYSQL (mysql = mariadb) por enquanto | |
| 'servidor' => 'localhost', | |
| 'user' => 'reservasalas', | |
| 'password' => 'salaspass', | |
| // Defina uma password forte e única no ficheiro real de configuração | |
| // e use um utilizador da BD com apenas as permissões mínimas necessárias. | |
| $db = array( | |
| 'tipo' => 'mysql', // Apenas há suporte a MYSQL (mysql = mariadb) por enquanto | |
| 'servidor' => 'localhost', | |
| 'user' => 'reservasalas', | |
| 'password' => '', |
| /// caso a autenticação seja por starttls, usar PHPMailer::ENCRYPTION_STARTTLS | ||
| /// caso a autenticação seja por ssl, usar PHPMailer::ENCRYPTION_SMTPS | ||
| /// caso não seja necessário autenticação, por false na opção autenticacao, e não importar-se para os outros |
There was a problem hiding this comment.
Os comentários com /// (linhas 25-27) não são um padrão usado no resto do projeto (normalmente é // ou /** ... */, p.ex. func/email_helper.php:49+). Sugiro uniformizar para // para evitar confusão com PHPDoc e manter consistência.
| /// caso a autenticação seja por starttls, usar PHPMailer::ENCRYPTION_STARTTLS | |
| /// caso a autenticação seja por ssl, usar PHPMailer::ENCRYPTION_SMTPS | |
| /// caso não seja necessário autenticação, por false na opção autenticacao, e não importar-se para os outros | |
| // caso a autenticação seja por starttls, usar PHPMailer::ENCRYPTION_STARTTLS | |
| // caso a autenticação seja por ssl, usar PHPMailer::ENCRYPTION_SMTPS | |
| // caso não seja necessário autenticação, por false na opção autenticacao, e não importar-se para os outros |
| 'urlResourceOwnerDetails' => 'https://authentik.devenv.marcopisco.com/application/o/userinfo/', | ||
| 'clientId' => 'clientid', // CHANGE THIS | ||
| 'clientSecret' => 'clientsecret', // CHANGE THIS and keep it secret | ||
| 'clientId' => 'clientid', | ||
| 'clientSecret' => 'clientsecret', |
There was a problem hiding this comment.
Foram removidas as notas que indicavam para alterar e manter secreto clientId/clientSecret. Como este ficheiro é tipicamente copiado para src/config.php, é fácil alguém fazer deploy com credenciais default; reintroduzir uma indicação explícita (e/ou placeholders mais óbvios) ajuda a prevenir configurações inseguras.
| ## Dependências | ||
|
|
||
| - Necessário um servidor com PHP e uma DB MariaDB | ||
| - PHP 8.4 |
There was a problem hiding this comment.
O README fixa a dependência em “PHP 8.4”, mas o projeto não declara a versão mínima no composer.json (não há "php": ... em require). Para evitar documentação potencialmente divergente, sugiro alinhar: ou indicar uma faixa/versão mínima suportada no README (ex.: >=8.x), ou adicionar a constraint correspondente no composer.json.
| - PHP 8.4 | |
| - PHP 8.4 ou superior |
No description provided.