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)
- Kliknij przycisk "+", aby dodać nowy identyfikator.
- Wybierz App IDs i kliknij Continue.
- Wybierz App i kliknij Continue.
- Wprowadź Opis dla swojego App ID (np.
LibreChat App ID). - Ustaw Bundle ID (np.
com.yourdomain.librechat). - Kliknij Continue, a następnie Register.
-
Odniesienia do obrazów:
-
Rysunek 1: Tworzenie nowego App ID -
Rysunek 2: Wybieranie identyfikatora aplikacji
4. Włącz "Sign in with Apple"
- Po utworzeniu App ID, kliknij na niego, aby edytować.
- W sekcji Capabilities znajdź i zaznacz Sign in with Apple.
- Kliknij Save.
- Odniesienie do obrazu:
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)
- Kliknij przycisk "+".
- Wybierz Services IDs i kliknij Continue.
- Wprowadź Opis (np.
LibreChat Services ID). - Wprowadź Identyfikator (np.
com.yourdomain.librechat.services). - Kliknij Continue, a następnie Register.
-
Odniesienia do obrazów:
-
Rysunek 4: Wybieranie identyfikatora usług (Services ID) -
Rysunek 5: Tworzenie identyfikatora Services ID
3. Skonfiguruj "Sign in with Apple"
- Kliknij na nowo utworzony Services ID.
- W sekcji Capabilities kliknij Configure obok Sign in with Apple.
- Wprowadź swoje Domeny (np.
your-domain.com) oraz Adresy URL powrotu (np.https://your-domain.com/oauth/apple/callback). - Kliknij Next, a następnie Register.
-
Odniesienie do obrazu:
-
Rysunek 6: Konfiguracja „Sign in with Apple” dla Services ID
-
Rysunek 7: Konfiguracja uwierzytelniania internetowego
-
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
- Kliknij przycisk "+", aby dodać nowy klucz.
- Wprowadź Key Name (np.
LibreChatSignInWithApple). - Wybierz Sign in with Apple w sekcji Capabilities.
- Kliknij Configure i wybierz utworzony App ID (np.
com.yourdomain.librechat), a następnie kliknij Save. - Kliknij Continue, a następnie Register.
-
Odniesienia do obrazów:
-
Rysunek 8: Tworzenie nowego klucza
-
Rysunek 9: Konfigurowanie klucza za pomocą App ID
-
Rysunek 10: Rejestrowanie klucza
3. Pobierz klucz prywatny
- Po utworzeniu klucza kliknij Download.
- Ważne: Zapisz plik
.p8w bezpiecznym miejscu. Nie będzie można go ponownie pobrać. - Zanotuj Key ID; będzie on potrzebny w pliku
.env.
- Odniesienie do obrazu:
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/callbackUwaga:
- Zastąp
com.yourdomain.librechat.servicesswoim rzeczywistym identyfikatorem Services ID.- Zastąp
YOUR_TEAM_IDorazYOUR_KEY_IDodpowiednimi wartościami ze swojego konta Apple Developer.- Jeśli używasz Docker, upewnij się, że plik
.p8jest dostępny wewnątrz kontenera Docker i odpowiednio zaktualizujAPPLE_PRIVATE_KEY_PATH.
2. Zrestartuj LibreChat
Po zaktualizowaniu pliku .env zrestartuj LibreChat, aby zastosować zmiany.
- Jeśli używasz Docker:
docker compose up -dRozwią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).
- Upewnij się, że identyfikator URI przekierowania w Twojej konsoli Apple Developer Console (
-
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.
- Zweryfikuj, czy ścieżka do pliku
-
Błędy Team ID i Key ID:
- Upewnij się, że
APPLE_TEAM_IDorazAPPLE_KEY_IDw Twoim pliku.envzgadzają się z tymi w Twoim koncie Apple Developer.
- Upewnij się, że
-
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
.p8jest poprawnie zamontowany, a ścieżka wAPPLE_PRIVATE_KEY_PATHjest dostępna wewnątrz kontenera.
- Jeśli używasz Docker, upewnij się, że plik
-
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?