Skip to content

Commit 9eae0bd

Browse files
committed
Tweaks to the discourse configs
1 parent 9e5705b commit 9eae0bd

File tree

1 file changed

+35
-37
lines changed

1 file changed

+35
-37
lines changed

readme.md

+35-37
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ $ composer require spinen/laravel-discourse-sso
3232

3333
The package uses the [auto registration feature](https://laravel.com/docs/5.8/packages#package-discovery) of Laravel 5.
3434

35-
## Configuration
35+
## Package Configuration
3636

3737
All of the configuration values are stored in under a `discourse` key in `config/services.php`. Here is the array to add...
3838

@@ -128,6 +128,40 @@ You can then add logic to the `User` model inside of [Accessors](https://laravel
128128
}
129129
```
130130

131+
## Discourse Configuration
132+
### Settings -> Login
133+
These are the configs we have under `Settings -> Login`. If a setting isn't listed, then ours is set to the default value.
134+
135+
| **Setting** | **Value** |
136+
|--------------------------|----------------------------------------------------------|
137+
| login required | true |
138+
| enable sso | true |
139+
| sso url | Our Laravel's SSO route (FQDN) |
140+
| sso secret | Our SSO secret key |
141+
| sso overrides bio | true |
142+
| sso overrides email | true |
143+
| sso overrides username | true |
144+
| sso overrides name | true |
145+
| sso overrides avatar | true |
146+
| sso not approved url | Our Laravel homepage (same as `url` in `config/app.php`) |
147+
| hide email address taken | true |
148+
_______________________________________________________________________
149+
150+
151+
### Settings -> Users
152+
These are the configs we have under `Settings -> Users`. If a setting isn't listed, then ours is set to the default value.
153+
154+
| **Setting** | **Value** |
155+
|-------------------------------------------|----------------------------------------------------------|
156+
| reserved usernames | We added our client's company name |
157+
| min password length | 8 |
158+
| min admin password length | 8 |
159+
| email editable | false |
160+
| logout redirect | Our Laravel homepage (same as `url` in `config/app.php`) |
161+
| purge unactivated users grace period days | 30 |
162+
| hide user profiles from public | true |
163+
_______________________________________________________________________
164+
131165
## Logging out the Discourse User
132166

133167
There's a listener in `src/Listeners/LogoutDiscourseUser.php` that will automatically log out the user from Discourse when certain events are fired. To use the Listener, [you need to register the event](https://laravel.com/docs/master/events#registering-events-and-listeners) in the `$listen` array in your `EventServiceProvider`.
@@ -147,42 +181,6 @@ When a Laravel `User` logs out, to log out their Discourse session Simply add th
147181
];
148182
```
149183

150-
## Discourse Configuration
151-
152-
### Settings -> Login
153-
These are the configs we have under `Settings -> Login`. If a setting isn't listed, then ours is set to the default value.
154-
155-
| **Setting** | **Value** |
156-
|--------------------------|--------------------------------|
157-
| login required | true |
158-
| enable sso | true |
159-
| sso url | Our Laravel's SSO route (FQDN) |
160-
| sso secret | Our SSO secret key |
161-
| sso overrides bio | true |
162-
| sso overrides email | true |
163-
| sso overrides username | true |
164-
| sso overrides name | true |
165-
| sso overrides avatar | true |
166-
| sso not approved url | Our Laravel homepage (FQDN) |
167-
| hide email address taken | true |
168-
_______________________________________________________________________
169-
170-
171-
### Settings -> Users
172-
These are the configs we have under `Settings -> Users`. If a setting isn't listed, then ours is set to the default value.
173-
174-
| **Setting** | **Value** |
175-
|-------------------------------------------|------------------------------------|
176-
| reserved usernames | We added our client's company name |
177-
| min password length | 8 |
178-
| min admin password length | 8 |
179-
| email editable | false |
180-
| logout redirect | Our Laravel homepage (FQDN) |
181-
| purge unactivated users grace period days | 30 |
182-
| hide user profiles from public | true |
183-
_______________________________________________________________________
184-
185-
186184
## Left to do
187185

188186
* badges for user

0 commit comments

Comments
 (0)