Apple

Erfahren Sie, wie Sie LibreChat für die Benutzerauthentifizierung mit Apple konfigurieren.

Voraussetzungen

Bevor Sie beginnen, stellen Sie sicher, dass Sie über Folgendes verfügen:

Apple Developer Account: Falls Sie noch keinen haben, registrieren Sie sich hier.

Erstellen einer neuen App-ID

1. Melden Sie sich bei der Apple Developer Console an

Aktion:
Besuchen Sie Apple Developer und melden Sie sich mit Ihrer Apple ID an.

2. Zu Identifiers navigieren

Gehen Sie zu Certificates, Identifiers & Profiles.
Klicken Sie in der Seitenleiste auf Identifiers.

3. Erstellen einer neuen App-ID

Klicken Sie auf die "+"-Schaltfläche, um eine neue Kennung hinzuzufügen.
Wählen Sie App IDs aus und klicken Sie auf Continue.
Wählen Sie App und klicken Sie auf Continue.
Geben Sie eine Beschreibung für Ihre App-ID ein (z. B. LibreChat App ID).
Legen Sie die Bundle ID fest (z. B. com.yourdomain.librechat).
Klicken Sie auf Continue und dann auf Register.

Bildreferenzen:
Abbildung 1: Erstellen einer neuen App-ID
Abbildung 2: App-Identifikator auswählen

Nachdem Sie die App ID erstellt haben, klicken Sie darauf, um sie zu bearbeiten.
Unter Capabilities finden und aktivieren Sie Sign in with Apple.
Klicken Sie auf Save.

Bildreferenz:
Abbildung 3: Aktivieren von „Sign in with Apple“

Erstellen einer Services ID

1. Zu Identifiers navigieren

Klicken Sie im Bereich Certificates, Identifiers & Profiles auf Identifiers.

2. Erstellen einer neuen Services-ID

Klicken Sie auf die Schaltfläche "+".
Wählen Sie Services IDs aus und klicken Sie auf Continue.
Geben Sie eine Beschreibung ein (z. B. LibreChat Services ID).
Geben Sie einen Identifier ein (z. B. com.yourdomain.librechat.services).
Klicken Sie auf Continue und dann auf Register.

Bildreferenzen:
Abbildung 4: Auswahl der Services ID
Abbildung 5: Erstellen der Services ID

Klicken Sie auf die neu erstellte Services ID.
Klicken Sie unter Capabilities neben Sign in with Apple auf Configure.
Geben Sie Ihre Domains (z. B. your-domain.com) und Return URLs (z. B. https://your-domain.com/oauth/apple/callback) ein.
Klicken Sie auf Next und dann auf Register.

Bildreferenz:
Abbildung 6: Konfiguration von „Sign in with Apple“ für die Services ID
Abbildung 7: Konfiguration der Web-Authentifizierung
Abbildung 8: Konfiguration der Services-ID speichern

Einen Schlüssel erstellen

1. Zu den Keys navigieren

Klicken Sie im Bereich Certificates, Identifiers & Profiles auf Keys.

2. Einen neuen Schlüssel erstellen

Klicken Sie auf die "+"-Schaltfläche, um einen neuen Schlüssel hinzuzufügen.
Geben Sie einen Key Name ein (z. B. LibreChatSignInWithApple).
Wählen Sie unter Capabilities die Option Sign in with Apple aus.
Klicken Sie auf Configure und wählen Sie die erstellte App ID aus (z. B. com.yourdomain.librechat), klicken Sie dann auf Save.
Klicken Sie auf Continue und dann auf Register.

Bildreferenzen:
Abbildung 8: Erstellen eines neuen Schlüssels
Abbildung 9: Konfiguration des Schlüssels mit App-ID
Abbildung 10: Registrieren des Schlüssels

3. Den privaten Schlüssel herunterladen

Nachdem Sie den Schlüssel erstellt haben, klicken Sie auf Download.
Wichtig: Speichern Sie die .p8-Datei sicher. Sie können sie nicht erneut herunterladen.
Notieren Sie sich die Key ID; Sie werden sie für die .env Datei benötigen.

Bildreferenz:
Abbildung 11: Herunterladen des privaten Schlüssels

Konfigurieren von LibreChat

1. `.env` Konfiguration aktualisieren

Fügen Sie die folgende Apple OAuth2-Konfiguration zu Ihrer .env Datei hinzu:

DOMAIN_CLIENT=https://your-domain.com # use http://localhost:3080 if not using a custom domain
DOMAIN_SERVER=https://your-domain.com # use http://localhost:3080 if not using a custom domain

# Apple
APPLE_CLIENT_ID=com.yourdomain.librechat.services
APPLE_TEAM_ID=YOUR_TEAM_ID
APPLE_KEY_ID=YOUR_KEY_ID
APPLE_PRIVATE_KEY_PATH=/path/to/AuthKey.p8 # Absolute path to your downloaded .p8 file
APPLE_CALLBACK_URL=/oauth/apple/callback

Hinweis:

Ersetzen Sie com.yourdomain.librechat.services durch Ihre tatsächliche Services ID.

Ersetzen Sie YOUR_TEAM_ID und YOUR_KEY_ID durch die jeweiligen Werte aus Ihrem Apple Developer-Konto.

Wenn Sie Docker verwenden, stellen Sie sicher, dass die .p8-Datei innerhalb Ihres Docker-Containers zugänglich ist, und aktualisieren Sie den APPLE_PRIVATE_KEY_PATH entsprechend.

2. LibreChat neu starten

Nachdem Sie die .env Datei aktualisiert haben, starten Sie LibreChat neu, um die Änderungen zu übernehmen.

Bei Verwendung von Docker:

docker compose up -d

Fehlerbehebung

Falls Sie während der Einrichtung auf Probleme stoßen, ziehen Sie die folgenden Lösungen in Betracht:

Ungültiger Redirect-URI:
- Stellen Sie sicher, dass die Redirect-URI in Ihrer Apple Developer Console (https://your-domain.com/oauth/apple/callback) exakt mit der in Ihrer .env Datei (APPLE_CALLBACK_URL) angegebenen übereinstimmt.
Probleme mit privaten Schlüsseln:
- Überprüfen Sie, ob der Pfad zu Ihrer .p8-Datei (APPLE_PRIVATE_KEY_PATH) korrekt ist.
- Stellen Sie sicher, dass LibreChat Leseberechtigungen für die .p8 Datei hat.
Team ID und Key ID Fehler:
- Überprüfen Sie noch einmal, ob die APPLE_TEAM_ID und die APPLE_KEY_ID in Ihrer .env Datei mit denen in Ihrem Apple Developer Account übereinstimmen.
Domain-Verifizierung fehlgeschlagen:
- Stellen Sie sicher, dass die Verifizierungsdatei korrekt in das Stammverzeichnis Ihrer Domain hochgeladen wurde.
- Überprüfen Sie, dass bei der Konfiguration keine Tippfehler im Domainnamen eingegeben wurden.
Docker-Konfigurationsprobleme:
- Wenn Sie Docker verwenden, stellen Sie sicher, dass die .p8-Datei korrekt gemountet ist und der Pfad in APPLE_PRIVATE_KEY_PATH innerhalb des Containers zugänglich ist.
Logs prüfen:
- Überprüfen Sie die LibreChat-Protokolle auf Fehlermeldungen im Zusammenhang mit der Apple-Authentifizierung. Dies kann spezifische Einblicke in die möglichen Ursachen des Problems liefern.