Configurar e-mail SMTP e SAML SSO
Configure o e-mail (para convites, recuperação de senha e verificação) e o login único via SAML em uma instância do OpenTickly auto-hospedada.
O e-mail (SMTP) é configurado uma vez só, para a instância inteira. Já o login único (SAML 2.0) é configurado separadamente em cada espaço de trabalho. Comece pela URL do site, porque os links dos e-mails e os endereços do SSO são montados a partir dela.
Configure a URL pública do site
Entre como administrador da instância e abra Administração da instância → Configuração. Em URL do site, coloque o endereço que seus usuários digitam no navegador, por exemplo https://time.example.com.
Não use um hostname interno do Docker e não acrescente /api nem nenhum outro caminho. Se mudar o domínio depois, confira se os links dos e-mails continuam funcionando e atualize as configurações de SSO no seu provedor de identidade.
Configure o envio de e-mail por SMTP
Em Administração da instância → Configuração → E-mail / SMTP, preencha:
| Campo | O que é |
|---|---|
| Nome do Remetente | Nome que aparece nas mensagens |
| E-mail do Remetente | Endereço de envio que o seu provedor de e-mail permite usar |
| Host SMTP | Endereço do servidor de e-mail |
| Porta SMTP | Porta do provedor; geralmente 587 para STARTTLS ou 465 para TLS direto |
| Usuário SMTP | Login no servidor de e-mail |
| Senha SMTP | Senha ou senha de app gerada pelo provedor |
Na porta 465, o OpenTickly já conecta com TLS desde o início. Nas outras portas, ele passa para STARTTLS se o servidor oferecer.
Salve, coloque um endereço em Enviar E-mail de Teste e envie um teste. Se der erro, a mensagem diz se não conseguiu conectar, se o login estava errado, se o destinatário foi recusado ou se o tempo esgotou. Assim você sabe se o problema está nas configurações do provedor ou no firewall.
Convites, recuperação de senha e verificação de e-mail dependem do SMTP. Quando o e-mail de teste chegar, você pode ativar a Verificação de E-mail para que novos usuários confirmem o endereço.
Não deixe a senha do SMTP aparecer em prints, issues, no git ou no histórico de um terminal compartilhado. Se ela vazar, troque.
Configure o SAML SSO do espaço de trabalho
O provedor de identidade (IdP) é o serviço que sua equipe já usa para fazer login, como Okta, Microsoft Entra ID, Google Workspace ou Keycloak.
Como administrador do espaço de trabalho, abra Configurações do espaço → Single Sign-On.
- Dê um nome e informe o domínio de e-mail da empresa (por exemplo
example.com). - No seu IdP, crie um novo app SAML e cole o ID da entidade, a URL do ACS, a URL de login e a URL de metadados que o OpenTickly mostra.
- De volta ao OpenTickly, cole a URL de metadados do IdP. Se o seu IdP não fornecer uma, informe manualmente a URL de login, o ID da entidade e o certificado de assinatura X.509 dele.
- Clique em Testar configuração antes de ativar o SSO.
- Clique em Testar início de sessão e entre com alguém desse domínio de e-mail. Confira se o e-mail, o nome e os outros dados voltam corretos.
- Salve e ative o login único.
Quando alguém usa o botão SSO na tela de login, o OpenTickly olha o domínio do e-mail da pessoa para decidir para qual espaço de trabalho mandá-la. Por isso, cada domínio só pode ser usado por um espaço de trabalho. O IdP precisa enviar o e-mail do usuário, seja como atributo de e-mail, seja como NameID.
Antes de liberar para todo mundo
Para não ficar trancado do lado de fora:
- Mantenha uma sessão de administrador aberta (entrando com senha) em outra aba enquanto testa.
- Teste primeiro com um usuário de teste, não com a equipe inteira.
- Confira se o ID da entidade e a URL do ACS no IdP são exatamente iguais aos que o OpenTickly mostra.
- Garanta que tanto os usuários quanto o IdP consigam acessar o OpenTickly por HTTPS.
- Teste de novo depois de mudar a URL do site, o proxy reverso, o certificado ou as configurações do IdP.
- Mantenha o login com senha disponível até pelo menos outro administrador conseguir entrar com SSO.
Para implantação e proxy reverso, veja Auto-hospedagem. Para tokens de API e scripts, veja Compatibilidade com a API Toggl.
Compatibilidade com a API Toggl
Aponte seus scripts, CLIs e agentes feitos para o Toggl para o OpenTickly. Quais URLs usar, como autenticar com um token de API e o que testar antes de trocar.
Auto-hospedagem
Rode o OpenTickly na sua própria máquina com Docker Compose. Um único comando sobe o app, o PostgreSQL e o Redis. Também cobre CasaOS, ZimaOS, Synology, fnOS e outras plataformas de NAS.