Um servidor de gerenciamento de usuários fácil de administrar (com chaves de acesso e JWTs) - para integração perfeita e segura da autenticação do usuário.
Links úteis: Documentação | REGISTRO DE MUDANÇAS | Site de demonstração | Siga no Mastodonte
AuthCompanion visa satisfazer as necessidades mais comuns de autenticação e gerenciamento de usuários para sua aplicação web.
Com AuthC você pode:
Tela de login | Tela de registro |
---|---|
As instruções abaixo iniciarão o servidor padrão para explorar os recursos.
Pré-requisito:
Clone o repositório, caso ainda não tenha feito isso, e instale as dependências usando este comando:
$ npm install
Quando estiver pronto, inicie o servidor com as configurações padrão!
$ npm start
Inicie o servidor (com a configuração padrão):
$ docker run -it -p 3002:3002 --name AuthCompanion ghcr.io/authcompanion/authcompanion2:main
Também está disponível o docker-compose.yml
Se você estiver testando o AuthC pela primeira vez, a configuração padrão funcionará. Consulte o Guia de Configuração para saber mais detalhadamente como configurar o servidor para outros ambientes.
Quando estiver pronto, leia o Guia de lançamento para obter mais informações sobre como configurar o AuthC em produção.
Formulários da Web para autenticação de usuário: use formulários da Web pré-construídos e personalizáveis para que os usuários do seu aplicativo: façam login com suas credenciais, registrem uma conta, atualizem seu perfil e emitam senhas esquecidas.
Painel de administração para gerenciamento de perfis de usuário: Modifique as informações de perfil de seus usuários por meio de um painel de autoatendimento - todas as informações da conta são armazenadas em um banco de dados SQLite.
Recuperação de conta de usuário: restaure o acesso de um usuário à sua conta usando o fluxo Esqueci a senha , que envia um link especial por e-mail para ajudar os usuários a recuperarem rapidamente sua conta.
Fluxo sem senha: simplifique o login e o registro do seu usuário com senha e autentique os usuários com um dispositivo móvel, chave de segurança USB ou computador.
Plataforma extensível: AuthC oferece suporte a um sistema de plug-ins para adicionar facilmente novas funcionalidades para cobrir mais necessidades de autenticação.
Authcompanion fornece formulários da web integrados para autenticação de usuário, incluindo páginas de login e registro.
Depois que um usuário se autentica nos formulários web do AuthC, nós os passamos para seu aplicativo web.
Para obter uma lista completa dos formulários da Web do AuthC, consulte o Guia de formulários da Web.
O Admin Dashboard é uma ferramenta que permite aos administradores ou proprietários de aplicativos gerenciar os usuários de seus aplicativos da web. Ele fornece uma variedade de funções que os administradores podem usar para criar, editar e excluir contas de usuários; tudo através de uma interface amigável e intuitiva.
Confira o Painel de Administração na documentação para saber como acessá-lo: Administrar.
A melhor maneira de aprender é fazendo; aqui estão algumas maneiras de começar.
Você pode usar a demonstração disponível publicamente em demo.authcompanion.com ou iniciar o servidor localmente.
O AuthC vem com Web Forms pré-construídos para ajudá-lo a integrar rapidamente a autenticação do usuário ao seu aplicativo da web.
Com o servidor AuthC em execução (nas etapas anteriores), comece primeiro registrando uma conta usando este formulário da web: http://localhost:3002/v1/web/register
Em seguida, faça login com a conta que você acabou de criar usando seu e-mail e senha neste formulário web: http://localhost:3002/v1/web/login. A resposta do servidor inclui um token de acesso para uso na autenticação em APIs de back-end e redireciona o usuário para a página inicial do seu aplicativo.
Faça login no Painel de Administração usando as credenciais encontradas no Guia de Administração e atualize o perfil do usuário que você criou na etapa anterior alterando seu e-mail (ou campo semelhante).
Dê uma olhada no Guia de integração para entender como seus aplicativos de front-end e serviços da web de back-end interagem com o AuthC.
A API de autenticação RESTful alimenta os Web Forms pelos quais os usuários se autenticam em seu aplicativo Web. É importante observar que os formulários web por si só não cobrem todos os fluxos de autenticação dos seus usuários. Por exemplo: atualizar um token de acesso expirado exigiria a interação com as APIs do AuthC, além do uso do Web Froms.
Para obter mais informações sobre a API de autenticação, verifique a documentação aqui: API de autenticação
A API Admin ajuda um administrador a gerenciar os usuários de seu aplicativo da web. Ele fornece uma variedade de funções por meio das quais os administradores podem criar, editar e excluir contas de usuário de maneira programática. A API Admin também é usada nativamente pelo Painel de Administração.
Para obter mais informações sobre a API Admin, verifique a documentação aqui: API Admin
AuthCompanion é licenciado sob a Licença Pública Big Time. Estes termos permitem que você use e compartilhe este software gratuitamente para fins não comerciais e em pequenas empresas, garantindo ao mesmo tempo que licenças pagas para grandes empresas estarão disponíveis em termos justos, razoáveis e não discriminatórios.
Parabéns pelo design do logotipo - Timothy Reeder (Github)
Trabalho pesado no protótipo e inspiração constante - Teddy Schmitz (Github)
Leve o AuthCompanion, o companheiro útil, para o seu próximo projeto web! ?