blomstra / oauth-apple
Sign in with Apple
Installs: 1 603
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 4
Forks: 0
Open Issues: 0
Type:flarum-extension
Requires
- firebase/php-jwt: 6.5.0
- flarum/core: ^1.2.0
- fof/oauth: ^1.3
- patrickbussmann/oauth2-apple: ^0.2.6
This package is auto-updated.
Last update: 2024-11-21 16:04:13 UTC
README
A Flarum extension. Log in with Apple
Installation
Install with composer:
composer require blomstra/oauth-apple:"*"
Updating
composer update blomstra/oauth-apple php flarum cache:clear
Configuration
-
Create an
App ID
for your website (https://developer.apple.com/account/resources/identifiers/list/bundleId) with the following details:- Platform: iOS, tvOS, watchOS (I'm unsure if either choice has an effect for web apps)
- Description: (something like "example.com app id")
- Bundle ID (Explicit): com.example.id (or something similar)
- Check "Sign In With Apple"
-
Create a
Service ID
for your website (https://developer.apple.com/account/resources/identifiers/list/serviceId) with the following details:- Description: (something like "example.com service id")
- Identifier: com.example.service (or something similar)
- Check "Sign In With Apple"
- Configure "Sign In With Apple":
- Primary App Id: (select the primary app id created in step 1)
- Web Domain: example.com (the domain of your web site)
- Return URLs: https://example.com/apple-signin (the route pointing to the callback method in your controller)
- Click "Save".
- Click the "Edit" button to edit the details of the "Sign In With Apple" configuration we just created.
- If you haven't verified the domain yet, download the verification file, upload it to https://example.com/.well-known/apple-developer-domain-association.txt, and then click the "Verify" button.
-
Create a
Private Key
for your website (https://developer.apple.com/account/resources/authkeys/list) with the following details:- Key Name:
- Check "Sign In With Apple"
- Configure "Sign In With Apple":
- Primary App ID: (select the primary app id created in step 1)
- Click "Save"
- Click "Continue"
- Click "Register"
- Click "Download"
- Keep the file safe for use in step 4.
-
Fill in the following fields in the extension settings:
team_id
: This can be found on the top-right corner when logged into your Apple Developer account, right under your name.client_id
: This is the identifier from the Service Id created in step 2 above, for example com.example.servicekey_id
: This is the identifier of the private key created in step 3 above.- Upload the key file downloaded in step 3.
Sponsored
The initial version of this extension was kindly sponsored by Kagi Search - an ad-free search engine