Apple

Vereisten

Voordat je begint, zorg ervoor dat je over het volgende beschikt:

• Apple Developer Account: Als je er nog geen hebt, schrijf je dan hier in.

Een nieuwe App ID aanmaken

1. Log in bij de Apple Developer Console

• Actie:
• Bezoek Apple Developer en meld je aan met je Apple ID.

2. Navigeer naar Identifiers

• Ga naar Certificates, Identifiers & Profiles.
• Klik op Identifiers in de zijbalk.

3. Maak een nieuwe App ID

1. Klik op de "+"-knop om een nieuwe identifier toe te voegen.
2. Selecteer App IDs en klik op Continue.
3. Kies App en klik op Continue.
4. Voer een Description in voor je App ID (bijv. LibreChat App ID).
5. Stel de Bundle ID in (bijv. com.yourdomain.librechat).
6. Klik op Continue en vervolgens op Register.

• Afbeeldingsreferenties:

• Figuur 1: Een nieuwe App ID aanmaken

• Figuur 2: App-identificatie selecteren

4. "Sign in with Apple" inschakelen

1. Nadat je de App ID hebt aangemaakt, klik je erop om deze te bewerken.
2. Onder Capabilities, zoek en vink Sign in with Apple aan.
3. Klik op Save.

• Afbeeldingsreferentie:
• Figuur 3: "Sign in with Apple" inschakelen

Een Services ID aanmaken

1. Navigeer naar Identifiers

• Klik in de sectie Certificates, Identifiers & Profiles op Identifiers.

2. Maak een nieuwe Services ID aan

1. Klik op de "+"-knop.
2. Selecteer Services IDs en klik op Continue.
3. Voer een Description in (bijv. LibreChat Services ID).
4. Voer een Identifier in (bijv. com.yourdomain.librechat.services).
5. Klik op Continue en vervolgens op Register.

• Afbeeldingsreferenties:

• Figuur 4: Services ID selecteren

• Figuur 5: Services ID aanmaken

3. Configure "Sign in with Apple"

1. Klik op de zojuist aangemaakte Services ID.
2. Klik onder Capabilities op Configure naast Sign in with Apple.
3. Voer uw Domains (bijv. your-domain.com) en Return URLs (bijv. https://your-domain.com/oauth/apple/callback) in.
4. Klik op Next en vervolgens op Register.

• Afbeeldingsreferentie:

• Figuur 6: "Sign in with Apple" configureren voor Services ID

• Figuur 7: Web Authentication Configuration

• Figuur 8: Configuratie van Services ID opslaan en bewerken

Een sleutel aanmaken

1. Navigeer naar Keys

• Klik in de sectie Certificates, Identifiers & Profiles op Keys.

2. Maak een nieuwe sleutel aan

1. Klik op de "+"-knop om een nieuwe sleutel toe te voegen.
2. Voer een Key Name in (bijv. LibreChatSignInWithApple).
3. Selecteer Sign in with Apple onder Capabilities.
4. Klik op Configure en selecteer de aangemaakte App ID (bijv. com.yourdomain.librechat) en klik vervolgens op Save.
5. Klik op Continue en vervolgens op Register.

• Afbeeldingsreferenties:

• Figuur 8: Een nieuwe sleutel aanmaken

• Figuur 9: De Key configureren met App ID

• Figuur 10: De sleutel registreren

3. Download de privésleutel

1. Nadat je de sleutel hebt aangemaakt, klik je op Download.
2. Belangrijk: Sla het .p8 bestand veilig op. Je zult het niet opnieuw kunnen downloaden.
3. Let op de Key ID; je hebt deze nodig voor het .env bestand.

• Afbeeldingsreferentie:
• Figuur 11: De privésleutel downloaden

LibreChat configureren

1. Update .env Configuration

Voeg de volgende Apple OAuth2-configuratie toe aan je .env bestand:

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

Let op:

• Vervang com.yourdomain.librechat.services door uw werkelijke Services ID.
• Vervang YOUR_TEAM_ID en YOUR_KEY_ID door de respectievelijke waarden uit je Apple Developer-account.
• Als je Docker gebruikt, zorg er dan voor dat het .p8 bestand toegankelijk is binnen je Docker container en werk de APPLE_PRIVATE_KEY_PATH dienovereenkomstig bij.

2. Herstart LibreChat

Nadat je het .env bestand hebt bijgewerkt, start je LibreChat opnieuw op om de wijzigingen toe te passen.

• Indien je Docker gebruikt:

docker compose up -d

Probleemoplossing

Als je problemen ondervindt tijdens de installatie, overweeg dan de volgende oplossingen:

• Ongeldige Redirect URI:

  • Zorg ervoor dat de redirect URI in je Apple Developer Console (https://your-domain.com/oauth/apple/callback) exact overeenkomt met degene die is opgegeven in je .env bestand (APPLE_CALLBACK_URL).

• Problemen met privésleutels:

  • Controleer of het pad naar je .p8 bestand (APPLE_PRIVATE_KEY_PATH) correct is.
  • Zorg ervoor dat LibreChat leesrechten heeft voor het .p8 bestand.

• Team ID en Key ID fouten:

  • Controleer dubbel of de APPLE_TEAM_ID en APPLE_KEY_ID in je .env bestand overeenkomen met die in je Apple Developer Account.

• Domeinverificatie mislukt:

  • Zorg ervoor dat het verificatiebestand correct is geüpload naar de root van uw domein.
  • Controleer of er geen typefouten in de domeinnaam staan die tijdens de configuratie is ingevoerd.

• Docker-configuratieproblemen:

  • Als je Docker gebruikt, bevestig dan dat het .p8 bestand correct is gekoppeld en dat het pad in APPLE_PRIVATE_KEY_PATH toegankelijk is binnen de container.

• Controleer logs:

  • Controleer de LibreChat-logs op eventuele foutmeldingen met betrekking tot Apple-authenticatie. Dit kan specifieke inzichten bieden in wat er mogelijk misgaat.