Skip to content

Commit c0e6e83

Browse files
committed
update: README & instruction guide
1 parent 7536e97 commit c0e6e83

File tree

4 files changed

+25
-20
lines changed

4 files changed

+25
-20
lines changed

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2022 Blomstra Ltd.
3+
Copyright (c) 2022-present GBCLStudio.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
66

README.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,48 @@
11
# Sign in With Slack
22

3-
![License](https://img.shields.io/badge/license-MIT-blue.svg) [![Latest Stable Version](https://img.shields.io/packagist/v/blomstra/oauth-slack.svg)](https://packagist.org/packages/blomstra/oauth-slack) [![Total Downloads](https://img.shields.io/packagist/dt/blomstra/oauth-slack.svg)](https://packagist.org/packages/blomstra/oauth-slack)
3+
![License](https://img.shields.io/badge/license-MIT-blue.svg) [![Latest Stable Version](https://img.shields.io/packagist/v/gbcl/oauth-logto.svg)](https://packagist.org/packages/gbcl/oauth-logto) [![Total Downloads](https://img.shields.io/packagist/dt/gbcl/oauth-logto.svg)](https://packagist.org/packages/gbcl/oauth-logto)
44

5-
A [Flarum](http://flarum.org) extension. Sign in with Slack
5+
A [Flarum](http://flarum.org) extension. Sign in with Logto Cloud or OSS
66

77
## Installation
88

99
Install with composer:
1010

1111
```sh
12-
composer require blomstra/oauth-slack:"*"
12+
composer require gbcl/oauth-logto:"*"
1313
```
1414

1515
## Updating
1616

1717
```sh
18-
composer update blomstra/oauth-slack
18+
composer update gbcl/oauth-logto
1919
php flarum cache:clear
2020
```
2121

2222
## Configuration
2323

24-
Once enabled, this extension will add a `Slack` option to the settings page of `fof/oauth`. Toggle `Slack` on, and hit the configure icon.
24+
Once enabled, this extension will add a `Logto` option to the settings page of `fof/oauth`. Toggle `Logto` on, and hit the configure icon.
2525

26-
Follow the [Slack documentation](https://api.slack.com/authentication/sign-in-with-slack) to create an [application](https://api.slack.com/apps)
26+
Created an `Traditional Web` Application on `Authentication > Applications > Create Application`
27+
Set the `Redirect URIs` labels to `https://your-flarum/auth/logto`,
28+
then, copy three things in the settings:
29+
- Logto endpoint
30+
- App secrets > Default secret > value
31+
- App ID
2732

28-
It is **imperitive** that you grant the following scopes to your new application at Slack:
29-
- `openid`
30-
- `email`
31-
- `profile`
33+
Paste the stuff above to the settings page of `fof/oauth`. One thing you need to notice that the `logto_domain` label needs to exclude the HTTP Protocol.
3234

33-
Set the callback URL as given in the extension settings.
35+
## Support
3436

35-
Enter the `Client ID` and `Client Secret` as displayed in the `Basic Information` page at Slack into the Flarum configuration.
36-
37-
Enjoy logging in with your Slack credentials!
37+
This extension is under active development. Provide [GitHub Issues](https://github.com/GBCLStudio/flarum-oauth-logto/issues) to help us improve.
3838

3939
## Links
4040

41-
- [Packagist](https://packagist.org/packages/blomstra/oauth-slack)
42-
- [GitHub](https://github.com/blomstra/flarum-ext-oauth-slack)
43-
- [Discuss](https://discuss.flarum.org/d/31039)
41+
- [Packagist](https://packagist.org/packages/gbcl/oauth-logto)
42+
- [GitHub](https://github.com/GBCLStudio/flarum-oauth-logto)
43+
44+
## Made with ❤ by GBCLStudio
45+
46+
Support Us:
47+
- [Afdian 爱发电](https://afdian.com/@GBCLStudio)
48+
- [OpenCollective](https://opencollective.com/gbclstudio)

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "gbcl/logto",
2+
"name": "gbcl/oauth-logto",
33
"description": "Sign in with Logto",
44
"keywords": [
55
"flarum", "logto", "oauth", "fof", "sso"

js/src/admin/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import app from 'flarum/admin/app';
22
import { ConfigureWithOAuthPage } from '@fof-oauth';
33

4-
app.initializers.add('gbcl-logto', () => {
4+
app.initializers.add('gbcl/oauth-logto', () => {
55
app.extensionData
66
.for('gbcl-logto')
77
.registerPage(ConfigureWithOAuthPage);

0 commit comments

Comments
 (0)