authcompanion2 Télécharger - authcompanion2 Téléchargement du code source

authcompanion2

Autres catégories

4.0.0-beta.1

Télécharger

AuthCompanion 2

Un serveur de gestion des utilisateurs convivial (avec clés d'accès et JWT) - pour une intégration transparente et sécurisée de l'authentification des utilisateurs.

Liens utiles : Documentation | JOURNAL DES MODIFICATIONS | Site de démonstration | Suivez Mastodon

Sujets d'actualité

Notre documentation comprend désormais 2 nouveaux fichiers .rest qui utilisent le plugin VS Code REST Client pour simplifier les tests d'API et fournir des exemples clairs des API d'administration et d'authentification d'Authcompanion.
Nouvelle prise en charge de Postgres lors du stockage des comptes d'utilisateurs + Nouveau style de formulaire Web de connexion et d'inscription - #22 [Terminé]
Une actualisation de la conception du tableau de bord d'administration - #21 [Terminé]

Introduction

AuthCompanion vise à satisfaire les besoins d'authentification et de gestion des utilisateurs les plus courants pour votre application Web.

Avec AuthC, vous pouvez :

Gérez en toute sécurité l’enregistrement, la connexion, la déconnexion et la récupération des comptes d’utilisateurs.
Générez et vérifiez les JWT, un jeton utilisé pour la session de votre utilisateur et authentifiez-les dans les API backend de votre application Web.
Gérez les utilisateurs via un tableau de bord en libre-service et stockez et possédez en toute confiance les comptes d'utilisateurs de votre application Web, selon vos conditions.
Aidez les utilisateurs à créer des comptes et à se connecter avec un mot de passe sur leur appareil mobile (c'est-à-dire sans mot de passe) ou en utilisant plutôt un nom d'utilisateur/des mots de passe traditionnels.

Écran de connexion	Écran d'inscription

Essayez-le

Les instructions ci-dessous lanceront le serveur par défaut pour explorer les fonctionnalités.

De la source

Pré-requis :

Version Node.js >=18.13

Clonez le dépôt si vous ne l'avez pas fait et installez les dépendances à l'aide de cette commande :

$ npm install

Lorsque vous êtes prêt, démarrez le serveur avec les paramètres par défaut !

$ npm start

Avec Docker

Démarrez le serveur (avec la configuration par défaut) :

$ docker run -it -p 3002:3002 --name AuthCompanion ghcr.io/authcompanion/authcompanion2:main

Le docker-compose.yml est également disponible

Configurer AuthCompanion

Si vous essayez AuthC pour la première fois, la configuration par défaut fonctionnera. Consultez le Guide de configuration pour en savoir plus sur la façon de configurer le serveur pour d'autres environnements.

Lancement

Lorsque vous êtes prêt, lisez le Guide de lancement pour plus d'informations sur la configuration d'AuthC en production.

Caractéristiques

Formulaires Web pour l'authentification des utilisateurs : utilisez des formulaires Web prédéfinis et personnalisables pour que les utilisateurs de votre application puissent : se connecter avec leurs informations d'identification, créer un compte, mettre à jour leur profil et émettre des mots de passe oubliés.
Tableau de bord d'administration pour la gestion des profils utilisateur : modifiez les informations de profil de vos utilisateurs via un tableau de bord en libre-service - toutes les informations de compte sont stockées dans une base de données SQLite.
Récupération de compte utilisateur : restaurez l'accès d'un utilisateur à son compte à l'aide du flux Mot de passe oublié qui envoie un lien spécial par e-mail pour aider les utilisateurs à récupérer rapidement leur compte.
Flux sans mot de passe : rationalisez la connexion et l'enregistrement de vos utilisateurs avec Passkey et authentifiez les utilisateurs avec un appareil mobile, une clé de sécurité USB ou un ordinateur.
Plateforme extensible : AuthC prend en charge un système de plugins pour ajouter facilement de nouvelles fonctionnalités afin de couvrir davantage vos besoins d'authentification.

Formulaires Web pour l'authentification

Authcompanion fournit des formulaires Web intégrés pour l'authentification des utilisateurs, y compris des pages de connexion et d'enregistrement.

Une fois qu'un utilisateur s'est authentifié auprès des formulaires Web d'AuthC, nous les transmettons à votre application Web.

Pour une liste complète des formulaires Web d'AuthC, consultez le Guide des formulaires Web.

Tableau de bord d'administration

Le tableau de bord d'administration est un outil qui permet aux administrateurs ou aux propriétaires d'applications de gérer les utilisateurs de leur application Web. Il fournit une gamme de fonctions que les administrateurs peuvent utiliser pour créer, modifier et supprimer des comptes d'utilisateurs ; le tout via une interface conviviale et intuitive.

Consultez le tableau de bord d'administration dans la documentation pour savoir comment y accéder : Administrer.

Administrateur

Explorer

La meilleure façon d’apprendre est de faire ; voici quelques façons de commencer.

Vous pouvez soit utiliser la démo disponible publiquement sur demo.authcompanion.com, soit démarrer le serveur localement.

1. Créez un utilisateur

AuthC est livré avec des formulaires Web prédéfinis pour vous aider à intégrer rapidement l'authentification des utilisateurs à votre application Web.

Avec le serveur AuthC en cours d'exécution (dans les étapes précédentes), commencez par enregistrer un compte à l'aide de ce formulaire Web : http://localhost:3002/v1/web/register

2. Connectez-vous en tant que nouvel utilisateur

Ensuite, connectez-vous avec le compte que vous venez de créer en utilisant votre e-mail et votre mot de passe sur ce formulaire Web : http://localhost:3002/v1/web/login. La réponse du serveur inclut un jeton d'accès à utiliser lors de l'authentification auprès des API backend et redirige l'utilisateur vers la page d'accueil de votre application.

3. Connectez-vous en tant qu'administrateur

Connectez-vous au tableau de bord d'administration à l'aide des informations d'identification trouvées via le guide d'administration et mettez à jour le profil de l'utilisateur que vous avez créé à l'étape précédente en modifiant son adresse e-mail (ou un champ similaire).

3. Lisez le guide d'intégration

Consultez le guide d'intégration pour comprendre comment vos applications frontend et vos services Web backend interagissent avec AuthC.

Documentation sur l'API

API d'authentification

L'API d'authentification RESTful alimente les formulaires Web grâce auxquels les utilisateurs s'authentifient dans votre application Web. Il est important de noter que les formulaires Web ne couvrent pas à eux seuls tous les flux d’authentification de vos utilisateurs. Par exemple : actualiser un jeton d'accès expiré nécessiterait d'interagir avec les API d'AuthC en plus d'utiliser les Web From.

Pour plus d'informations sur l'API d'authentification, consultez la documentation ici : API d'authentification

API d'administration

L'API Admin aide un administrateur à gérer les utilisateurs de son application Web. Il fournit une gamme de fonctions grâce auxquelles les administrateurs peuvent créer, modifier et supprimer des comptes d'utilisateurs par programme. L'API Admin est également utilisée de manière native par le tableau de bord d'administration.

Pour plus d'informations sur l'API Admin, consultez la documentation ici : API Admin

Licence

AuthCompanion est sous licence Big Time Public License. Ces conditions vous permettent d'utiliser et de partager gratuitement ce logiciel à des fins non commerciales et dans les petites entreprises, tout en garantissant également que les licences payantes pour les grandes entreprises seront disponibles à des conditions équitables, raisonnables et non discriminatoires.