Apple

Tìm hiểu cách cấu hình LibreChat để sử dụng Apple cho xác thực người dùng.

Điều kiện tiên quyết

Trước khi bắt đầu, hãy đảm bảo bạn đã có những thứ sau:

Tài khoản Apple Developer: Nếu bạn chưa có, hãy đăng ký tại đây.

Tạo App ID mới

1. Đăng nhập vào Apple Developer Console

Hành động:
Truy cập Apple Developer và đăng nhập bằng Apple ID của bạn.

2. Điều hướng đến Identifiers

Đi đến Certificates, Identifiers & Profiles.
Nhấp vào Identifiers trong thanh bên.

3. Tạo một App ID mới

Nhấp vào nút "+" để thêm một định danh mới.
Chọn App IDs và nhấp vào Continue.
Chọn App và nhấp vào Continue.
Nhập Description cho App ID của bạn (ví dụ: LibreChat App ID).
Thiết lập Bundle ID (ví dụ: com.yourdomain.librechat).
Nhấp vào Continue và sau đó là Register.

Tham chiếu hình ảnh:
Hình 1: Tạo App ID mới
Hình 2: Chọn Định danh Ứng dụng

Sau khi tạo App ID, hãy nhấp vào đó để chỉnh sửa.
Trong phần Capabilities, hãy tìm và chọn Sign in with Apple.
Nhấp vào Save.

Tham chiếu hình ảnh:
Hình 3: Bật "Sign in with Apple"

Tạo Services ID

1. Điều hướng đến Identifiers

Trong phần Certificates, Identifiers & Profiles, hãy nhấp vào Identifiers.

2. Tạo một Services ID mới

Nhấp vào nút "+".
Chọn Services IDs và nhấp vào Continue.
Nhập một Description (ví dụ: LibreChat Services ID).
Nhập một Identifier (ví dụ: com.yourdomain.librechat.services).
Nhấp vào Continue và sau đó là Register.

Tham chiếu hình ảnh:
Hình 4: Chọn Services ID
Hình 5: Tạo Services ID

Nhấp vào Services ID vừa được tạo.
Trong phần Capabilities, nhấp vào Configure bên cạnh Sign in with Apple.
Nhập Domains (ví dụ: your-domain.com) và Return URLs (ví dụ: https://your-domain.com/oauth/apple/callback) của bạn.
Nhấp vào Next và sau đó là Register.

Tham chiếu hình ảnh:
Hình 6: Cấu hình "Sign in with Apple" cho Services ID
Hình 7: Cấu hình xác thực web
Hình 8: Lưu cấu hình ID Dịch vụ đã chỉnh sửa

Tạo Key

1. Điều hướng đến Keys

Trong phần Certificates, Identifiers & Profiles, hãy nhấp vào Keys.

2. Tạo một Key mới

Nhấp vào nút "+" để thêm một khóa mới.
Nhập một Key Name (ví dụ: LibreChatSignInWithApple).
Chọn Sign in with Apple trong mục Capabilities.
Nhấp vào Configure và chọn App ID đã tạo (ví dụ: com.yourdomain.librechat), sau đó nhấp vào Save.
Nhấp vào Continue và sau đó là Register.

Tham chiếu hình ảnh:
Hình 8: Tạo khóa mới
Hình 9: Cấu hình Key với App ID
Hình 10: Đăng ký khóa

3. Tải xuống Khóa riêng (Private Key)

Sau khi tạo khóa, hãy nhấp vào Download.
Quan trọng: Lưu tệp .p8 một cách an toàn. Bạn sẽ không thể tải xuống tệp này lần nữa.
Lưu ý Key ID; bạn sẽ cần nó cho tệp .env.

Tham chiếu hình ảnh:
Hình 11: Tải xuống Khóa riêng tư (Private Key)

Cấu hình LibreChat

1. Cập nhật cấu hình `.env`

Thêm cấu hình Apple OAuth2 sau đây vào tệp .env của bạn:

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

Lưu ý:

Thay thế com.yourdomain.librechat.services bằng Services ID thực tế của bạn.

Thay thế YOUR_TEAM_ID và YOUR_KEY_ID bằng các giá trị tương ứng từ tài khoản Apple Developer của bạn.

Nếu sử dụng Docker, hãy đảm bảo tệp .p8 có thể truy cập được bên trong Docker container của bạn và cập nhật APPLE_PRIVATE_KEY_PATH cho phù hợp.

2. Khởi động lại LibreChat

Sau khi cập nhật tệp .env, hãy khởi động lại LibreChat để áp dụng các thay đổi.

Nếu sử dụng Docker:

docker compose up -d

Khắc phục sự cố

Nếu bạn gặp sự cố trong quá trình thiết lập, hãy cân nhắc các giải pháp sau:

URI chuyển hướng không hợp lệ:
- Đảm bảo rằng URI chuyển hướng trong Apple Developer Console của bạn (https://your-domain.com/oauth/apple/callback) khớp chính xác với URI được chỉ định trong tệp .env của bạn (APPLE_CALLBACK_URL).
Các vấn đề về Private Key:
- Xác minh rằng đường dẫn đến tệp .p8 của bạn (APPLE_PRIVATE_KEY_PATH) là chính xác.
- Đảm bảo rằng LibreChat có quyền đọc đối với tệp .p8.
Lỗi Team ID và Key ID:
- Hãy kiểm tra kỹ để đảm bảo rằng APPLE_TEAM_ID và APPLE_KEY_ID trong tệp .env của bạn khớp với các giá trị trong Tài khoản Nhà phát triển Apple của bạn.
Xác minh tên miền thất bại:
- Đảm bảo rằng tệp xác minh đã được tải lên chính xác vào thư mục gốc của tên miền của bạn.
- Xác minh rằng không có lỗi chính tả trong tên miền đã nhập trong quá trình cấu hình.
Các vấn đề về cấu hình Docker:
- Nếu sử dụng Docker, hãy xác nhận rằng tệp .p8 đã được mount đúng cách và đường dẫn trong APPLE_PRIVATE_KEY_PATH có thể truy cập được bên trong container.
Kiểm tra nhật ký (Logs):
- Xem lại nhật ký (logs) của LibreChat để tìm bất kỳ thông báo lỗi nào liên quan đến xác thực Apple. Điều này có thể cung cấp thông tin chi tiết cụ thể về những gì có thể đang xảy ra lỗi.

Apple

Trên trang này