bookstack/website
Fork 4
Code Issues 5 Pull requests Activity

Made required doc updates for v0.19 changes

Browse source 
Also enabled post modified times via last git change
This commit is contained in:
Dan Brown 2017-12-09 20:05:30 +00:00
commit 8e5ea454dc
Signed by: danb
GPG key ID: 46D9F943C24A2EF9
8 changed files with 49 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

2
content/docs/admin/installation.md
View file

@ -18,7 +18,7 @@ Below are some different methods of installing BookStack. If you cannot find a g
BookStack has similar requirements to Laravel:
* PHP >= 5.6.4, Will need to be usable from the command line.
* PHP >= 7.0.0, Will need to be usable from the command line.
* PHP Extensions: `OpenSSL`, `PDO`, `MBstring`, `Tokenizer`, `GD`, `MySQLND`, `Tidy`
* MySQL >= 5.6, Single DB *(All permissions advised since application manages schema)*
* Git *(Not strictly required but helps manage updates)*

33
content/docs/admin/social-auth.md → content/docs/admin/third-party-auth.md
View file

@ -1,11 +1,14 @@
+++
title = "Social Authentication"
description = "Enabling and configuring social authentication for easier logins"
title = "Third Party Authentication"
description = "Enabling and configuring third-party authentication for easier logins"
date = "2017-01-01"
type = "admin-doc"
aliases = [
"/docs/admin/social-auth"
]
+++
BookStack currently supports login via Google, Facebook, Slack, Twitter & GitHub. Once enabled options for these services will show up in the login, registration and user profile pages. By default these services are disabled. To enable them you will have to create an application on the external services to obtain the require application id's and secrets. Here are instructions to do this for the current supported services:
BookStack currently supports login via Google, Facebook, Slack, Twitter, GitHub, AzureAD and Okta. Once enabled options for these services will show up in the login, registration and user profile pages. By default these services are disabled. To enable them you will have to create an application on the external services to obtain the require application id's and secrets. Here are instructions to do this for the current supported services:
---
@ -126,3 +129,27 @@ To create a Twitter application for signing in with you may require a phone numb
APP_URL=http://mybookstackurl.com
```
10. All done! Users should now be able to link their AzureAD account in their account profile pages and also register/login using their Slack account.
---
### Okta
1. Login to Okta and, once logged in, Note the current URL. This is used for the 'BASE_URL' in step 6.
2. Navigate to the Admin panel then 'Applications' then select 'Add Application'. Then select 'Create New App' on the left.
3. For the 'Platform' choose 'Web'. For the 'Sign on method' choose 'OpenID Connect' then click 'Create'.
4. Give the app a name such as 'BookStack' or 'Our documentation'. Under the 'Login redirect URIs' option add both of the below URLs, Changing `https://example.com` to the base URL of your BookStack instance:
- `https://example.com/login/service/okta/callback`
- `https://example.com/register/service/okta/callback`
5. Save and scroll down to the 'Client Credentials' area. Copy the 'Client ID' and 'Client secret' values. These are your 'APP_ID' and 'APP_SECRET' values for step 6.
6. Copy these details and add them as new variables in your `.env` file like so:
```bash
# Replace the below (including '{}' braces) with your okta APP_ID and APP_SECRET and BASE_URL.
OKTA_APP_ID={APP_ID}
OKTA_APP_SECRET={APP_SECRET}
# The base URL is the URL from step 1 but with everything after the domain (okta.com) removed.
OKTA_BASE_URL={BASE_URL}
# APP_URL Needs to be set to your BookStack base url
APP_URL=http://mybookstackurl.com
```
7. All set up! Remember to assign the new application you created in Okta to your Okta users otherwise they will not be able to register/login using the service.

6
content/docs/admin/updates.md
View file

@ -30,6 +30,12 @@ Check the below list for the version you are updating to for any additional inst
## Version Specific Instructions
#### Updating to v0.19 or higher
Version v0.19 needs the following requirement change:
* Minimum required version of PHP has changed from 5.6.4 to 7.0.0.
#### Updating to v0.18 or higher
Version v0.18 introduced a commenting system. After updating you should check the permissions for all roles if you'd like to enable comments for your users.

8
content/docs/user/markdown-editor.md
View file

@ -6,9 +6,7 @@ type = "user-doc"
+++
If you prefer the write in Markdown the editor in BookStack can be changed at a instance level
to use a markdown editor instead of the default WYSIWYG editor.
The option to use Markdown is currently **not** a user setting but a global instance setting
to use a markdown editor instead of the default WYSIWYG editor. The option to use Markdown is currently **not** a user setting but a global instance setting
due to formatting differences between the two editors.
### Editor Shortcuts
@ -27,6 +25,10 @@ The following shortcuts are available in the Markdown Editor:
<td><code>Ctrl+S</code> / <code>Cmd+S</code></td>
<td>Save Draft</td>
</tr>
<tr>
<td><code>Ctrl+Enter</code> / <code>Cmd+Enter</code></td>
<td>Save Page &amp; Continue</td>
</tr>
<tr>
<td>
<code>Ctrl+1</code> / <code>Cmd+1</code> <br>

4
content/docs/user/wysiwyg-editor.md
View file

@ -24,6 +24,10 @@ The following shortcuts are available in the WYSIWYG Editor:
<td><code>Ctrl+S</code> / <code>Cmd+S</code></td>
<td>Save Draft</td>
</tr>
<tr>
<td><code>Ctrl+Enter</code> / <code>Cmd+Enter</code></td>
<td>Save Page &amp; Continue</td>
</tr>
<tr>
<td><code>Ctrl+B</code> / <code>Cmd+B</code></td>
<td>Bold</td>