Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat

Apple

Dowiedz się, jak skonfigurować LibreChat, aby używać Apple do uwierzytelniania użytkowników.

Wymagania wstępne

Zanim zaczniesz, upewnij się, że posiadasz następujące elementy:

  • Konto Apple Developer: Jeśli go nie posiadasz, zarejestruj się tutaj.

Tworzenie nowego App ID

1. Zaloguj się do Apple Developer Console

  • Akcja:
  • Odwiedź Apple Developer i zaloguj się za pomocą swojego Apple ID.

2. Przejdź do Identifiers

  • Przejdź do Certificates, Identifiers & Profiles.
  • Kliknij Identifiers na pasku bocznym.

3. Utwórz nowy identyfikator aplikacji (App ID)

  1. Kliknij przycisk "+", aby dodać nowy identyfikator.
  2. Wybierz App IDs i kliknij Continue.
  3. Wybierz App i kliknij Continue.
  4. Wprowadź Opis dla swojego App ID (np. LibreChat App ID).
  5. Ustaw Bundle ID (np. com.yourdomain.librechat).
  6. Kliknij Continue, a następnie Register.
  • Odniesienia do obrazów:

  • Create App ID Rysunek 1: Tworzenie nowego App ID

  • Select App Rysunek 2: Wybieranie identyfikatora aplikacji

4. Włącz "Sign in with Apple"

  1. Po utworzeniu App ID, kliknij na niego, aby edytować.
  2. W sekcji Capabilities znajdź i zaznacz Sign in with Apple.
  3. Kliknij Save.
  • Odniesienie do obrazu:
  • Enable Sign in with Apple Rysunek 3: Włączanie „Sign in with Apple”

Tworzenie identyfikatora Services ID

1. Przejdź do Identifiers

  • W sekcji Certificates, Identifiers & Profiles kliknij Identifiers.

2. Utwórz nowy identyfikator usługi (Services ID)

  1. Kliknij przycisk "+".
  2. Wybierz Services IDs i kliknij Continue.
  3. Wprowadź Opis (np. LibreChat Services ID).
  4. Wprowadź Identyfikator (np. com.yourdomain.librechat.services).
  5. Kliknij Continue, a następnie Register.
  • Odniesienia do obrazów:

  • Select Services ID Rysunek 4: Wybieranie identyfikatora usług (Services ID)

  • Create Services ID Rysunek 5: Tworzenie identyfikatora Services ID

3. Skonfiguruj "Sign in with Apple"

  1. Kliknij na nowo utworzony Services ID.
  2. W sekcji Capabilities kliknij Configure obok Sign in with Apple.
  3. Wprowadź swoje Domeny (np. your-domain.com) oraz Adresy URL powrotu (np. https://your-domain.com/oauth/apple/callback).
  4. Kliknij Next, a następnie Register.
  • Odniesienie do obrazu:

  • Configure Sign in with Apple Rysunek 6: Konfiguracja „Sign in with Apple” dla Services ID

  • Konfiguracja uwierzytelniania internetowego Rysunek 7: Konfiguracja uwierzytelniania internetowego

  • Web Authentication Configuration Rysunek 8: Zapisz konfigurację ID usług edycji


Tworzenie klucza

1. Przejdź do Keys

  • W sekcji Certificates, Identifiers & Profiles kliknij Keys.

2. Utwórz nowy klucz

  1. Kliknij przycisk "+", aby dodać nowy klucz.
  2. Wprowadź Key Name (np. LibreChatSignInWithApple).
  3. Wybierz Sign in with Apple w sekcji Capabilities.
  4. Kliknij Configure i wybierz utworzony App ID (np. com.yourdomain.librechat), a następnie kliknij Save.
  5. Kliknij Continue, a następnie Register.
  • Odniesienia do obrazów:

  • Create Key Rysunek 8: Tworzenie nowego klucza

  • Configure Key Rysunek 9: Konfigurowanie klucza za pomocą App ID

  • Register a New Key Rysunek 10: Rejestrowanie klucza

3. Pobierz klucz prywatny

  1. Po utworzeniu klucza kliknij Download.
  2. Ważne: Zapisz plik .p8 w bezpiecznym miejscu. Nie będzie można go ponownie pobrać.
  3. Zanotuj Key ID; będzie on potrzebny w pliku .env.
  • Odniesienie do obrazu:
  • Download Your Key Rysunek 11: Pobieranie klucza prywatnego

Konfigurowanie LibreChat

1. Aktualizacja konfiguracji .env

Dodaj poniższą konfigurację Apple OAuth2 do swojego pliku .env:

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

Uwaga:

  • Zastąp com.yourdomain.librechat.services swoim rzeczywistym identyfikatorem Services ID.
  • Zastąp YOUR_TEAM_ID oraz YOUR_KEY_ID odpowiednimi wartościami ze swojego konta Apple Developer.
  • Jeśli używasz Docker, upewnij się, że plik .p8 jest dostępny wewnątrz kontenera Docker i odpowiednio zaktualizuj APPLE_PRIVATE_KEY_PATH.

2. Zrestartuj LibreChat

Po zaktualizowaniu pliku .env zrestartuj LibreChat, aby zastosować zmiany.

  • Jeśli używasz Docker:
docker compose up -d

Rozwiązywanie problemów

Jeśli napotkasz problemy podczas konfiguracji, rozważ następujące rozwiązania:

  • Nieprawidłowy identyfikator URI przekierowania:

    • Upewnij się, że identyfikator URI przekierowania w Twojej konsoli Apple Developer Console (https://your-domain.com/oauth/apple/callback) dokładnie odpowiada temu określonemu w Twoim pliku .env (APPLE_CALLBACK_URL).
  • Problemy z kluczem prywatnym:

    • Zweryfikuj, czy ścieżka do pliku .p8 (APPLE_PRIVATE_KEY_PATH) jest poprawna.
    • Upewnij się, że LibreChat ma uprawnienia do odczytu pliku .p8.
  • Błędy Team ID i Key ID:

    • Upewnij się, że APPLE_TEAM_ID oraz APPLE_KEY_ID w Twoim pliku .env zgadzają się z tymi w Twoim koncie Apple Developer.
  • Weryfikacja domeny nie powiodła się:

    • Upewnij się, że plik weryfikacyjny został poprawnie przesłany do katalogu głównego Twojej domeny.
    • Sprawdź, czy w nazwie domeny wprowadzonej podczas konfiguracji nie ma literówek.
  • Problemy z konfiguracją Docker:

    • Jeśli używasz Docker, upewnij się, że plik .p8 jest poprawnie zamontowany, a ścieżka w APPLE_PRIVATE_KEY_PATH jest dostępna wewnątrz kontenera.
  • Sprawdź logi:

    • Przejrzyj logi LibreChat pod kątem komunikatów o błędach związanych z uwierzytelnianiem Apple. Może to dostarczyć szczegółowych informacji na temat tego, co może być przyczyną problemu.

Jaka jest ta instrukcja?