Ein admin-freundlicher Benutzerverwaltungsserver (mit Passkeys und JWTs) – für eine nahtlose und sichere Integration der Benutzerauthentifizierung.
Nützliche Links: Dokumentation | CHANGELOG | Demo-Site | Folgen Sie Mastodon
AuthCompanion zielt darauf ab, die häufigsten Authentifizierungs- und Benutzerverwaltungsanforderungen für Ihre Webanwendung zu erfüllen.
Mit AuthC können Sie:
Anmeldebildschirm | Registrierungsbildschirm |
---|---|
Mit den folgenden Anweisungen wird der Standardserver zum Erkunden der Funktionen gestartet.
Voraussetzung:
Klonen Sie das Repo, falls Sie dies noch nicht getan haben, und installieren Sie Abhängigkeiten mit diesem Befehl:
$ npm install
Wenn Sie bereit sind, starten Sie den Server mit den Standardeinstellungen!
$ npm start
Starten Sie den Server (mit der Standardkonfiguration):
$ docker run -it -p 3002:3002 --name AuthCompanion ghcr.io/authcompanion/authcompanion2:main
Ebenfalls verfügbar ist die Datei docker-compose.yml
Wenn Sie AuthC zum ersten Mal ausprobieren, funktioniert die Standardkonfiguration. Weitere Informationen zur Konfiguration des Servers für andere Umgebungen finden Sie im Konfigurationshandbuch.
Wenn Sie bereit sind, lesen Sie den Einführungsleitfaden, um weitere Informationen zum Einrichten von AuthC in der Produktion zu erhalten.
Webformulare zur Benutzerauthentifizierung: Verwenden Sie vorgefertigte und anpassbare Webformulare für Ihre Anwendungsbenutzer, um sich mit ihren Anmeldeinformationen anzumelden, ein Konto zu registrieren, ihr Profil zu aktualisieren und vergessene Passwörter auszugeben.
Admin-Dashboard zur Verwaltung von Benutzerprofilen: Ändern Sie die Profilinformationen Ihrer Benutzer über ein Self-Service-Dashboard – alle Kontoinformationen werden in einer SQLite-Datenbank gespeichert.
Wiederherstellung des Benutzerkontos: Stellen Sie den Zugriff eines Benutzers auf sein Konto mithilfe des Flusses „Passwort vergessen“ wieder her, der einen speziellen Link per E-Mail sendet, um Benutzern bei der schnellen Wiederherstellung ihres Kontos zu helfen.
Passwortloser Ablauf: Optimieren Sie die Anmeldung und Registrierung Ihrer Benutzer mit Passkey und authentifizieren Sie Benutzer mit einem mobilen Gerät, einem USB-Sicherheitsschlüssel oder einem Computer.
Erweiterbare Plattform: AuthC unterstützt ein Plugin-System zum einfachen Hinzufügen neuer Funktionen, um mehr Ihrer Authentifizierungsanforderungen abzudecken.
Authcompanion bietet integrierte Webformulare zur Benutzerauthentifizierung, einschließlich Anmelde- und Registrierungsseiten.
Nachdem sich ein Benutzer mit den Webformularen von AuthC authentifiziert hat, übergeben wir sie an Ihre Webanwendung.
Eine vollständige Liste der Webformulare von AuthC finden Sie im Web Form Guide.
Das Admin-Dashboard ist ein Tool, mit dem Administratoren oder Anwendungseigentümer die Benutzer ihrer Webanwendung verwalten können. Es bietet eine Reihe von Funktionen, mit denen Administratoren Benutzerkonten erstellen, bearbeiten und löschen können. Alles über eine benutzerfreundliche und intuitive Benutzeroberfläche.
Sehen Sie sich das Admin-Dashboard in der Dokumentation an, um zu erfahren, wie Sie darauf zugreifen können: Verwalten.
Der beste Weg zu lernen ist, etwas zu tun; Hier sind ein paar Möglichkeiten, um anzufangen.
Sie können entweder die öffentlich verfügbare Demo unter demo.authcompanion.com verwenden oder den Server lokal starten.
AuthC verfügt über vorgefertigte Webformulare, die Ihnen dabei helfen, die Benutzerauthentifizierung schnell in Ihre Webanwendung zu integrieren.
Beginnen Sie bei laufendem AuthC-Server (in den vorherigen Schritten) zunächst mit der Registrierung eines Kontos über dieses Webformular: http://localhost:3002/v1/web/register
Melden Sie sich anschließend mit dem Konto, das Sie gerade erstellt haben, mit Ihrer E-Mail-Adresse und Ihrem Passwort in diesem Webformular an: http://localhost:3002/v1/web/login. Die Serverantwort enthält ein Zugriffstoken zur Verwendung bei der Authentifizierung bei Backend-APIs und leitet den Benutzer zur Homepage Ihrer Anwendung weiter.
Melden Sie sich mit den im Administratorhandbuch gefundenen Anmeldeinformationen beim Admin-Dashboard an und aktualisieren Sie das Profil des Benutzers, das Sie im vorherigen Schritt erstellt haben, indem Sie seine E-Mail-Adresse (oder ein ähnliches Feld) ändern.
Sehen Sie sich den Integrationsleitfaden an, um zu verstehen, wie Ihre Frontend-Anwendungen und Backend-Webdienste mit AuthC interagieren.
Die RESTful-Authentifizierungs-API unterstützt die Webformulare, mit denen sich Benutzer bei Ihrer Web-App authentifizieren. Es ist wichtig zu beachten, dass die Webformulare allein nicht jeden Authentifizierungsablauf für Ihre Benutzer abdecken. Beispiel: Das Aktualisieren eines abgelaufenen Zugriffstokens würde zusätzlich zur Verwendung der Web Froms die Interaktion mit den APIs von AuthC erfordern.
Weitere Informationen zur Authentifizierungs-API finden Sie in den Dokumenten hier: Auth API
Die Admin-API hilft einem Administrator, die Benutzer seiner Webanwendung zu verwalten. Es bietet eine Reihe von Funktionen, mit denen Administratoren Benutzerkonten programmgesteuert erstellen, bearbeiten und löschen können. Die Admin-API wird auch nativ vom Admin-Dashboard verwendet.
Weitere Informationen zur Admin-API finden Sie in den Dokumenten hier: Admin-API
AuthCompanion ist unter der Big Time Public License lizenziert. Mit diesen Bedingungen können Sie diese Software für nichtkommerzielle Zwecke und in kleinen Unternehmen kostenlos nutzen und weitergeben. Gleichzeitig wird gewährleistet, dass kostenpflichtige Lizenzen für große Unternehmen zu fairen, angemessenen und nicht diskriminierenden Bedingungen verfügbar sind.
Ein Hoch auf das Logo-Design – Timothy Reeder (Github)
Schwere Arbeit am Prototyp und ständige Inspiration – Teddy Schmitz (Github)
Nehmen Sie AuthCompanion, den nützlichen Sidekick, in Ihr nächstes Webprojekt mit! ?