Skip to content

Commit 9e5705b

Browse files
committed
Document discourse configuration
1 parent 2812302 commit 9e5705b

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

readme.md

+36-1
Original file line numberDiff line numberDiff line change
@@ -147,9 +147,44 @@ When a Laravel `User` logs out, to log out their Discourse session Simply add th
147147
];
148148
```
149149

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+
150186
## Left to do
151187

152-
* document Discourse configuration
153188
* badges for user
154189
* support for [`custom_fields`](https://meta.discourse.org/t/custom-user-fields-for-plugins/14956)
155190
* failed login redirect

0 commit comments

Comments
 (0)