]> BookStack Code Mirror - website/commitdiff
Added post images, proof-read doc changes
authorDan Brown <redacted>
Mon, 1 May 2023 18:36:28 +0000 (19:36 +0100)
committerDan Brown <redacted>
Mon, 1 May 2023 18:36:28 +0000 (19:36 +0100)
content/blog/bookstack-release-v23-05.md
content/docs/admin/email-webhooks.md
content/docs/admin/hacking-bookstack.md
content/docs/admin/visual-customisation.md
content/docs/user/reusing-content.md
static/images/2023/05/attachment-upload.png [new file with mode: 0644]
static/images/2023/05/clojure-code-syntax.png [new file with mode: 0644]
static/images/2023/05/codemirror-6-block.png [new file with mode: 0644]
static/images/2023/05/image-permissions-api-endpoints.png [new file with mode: 0644]
static/images/2023/05/image-upload-error.png [new file with mode: 0644]

index 59a8a0e80dc5be4013fc2f756b2cc1c2f39af542..e1768d37acfbfde427fb27f6df0897e86128af5e 100644 (file)
@@ -67,7 +67,7 @@ File upload handling has been revamped in a few key areas, specifically the imag
 The new experience switches out our previous usage of the [dropzone.js](https://www.dropzone.dev/) library with a much more lightweight 
 custom implementation to provide a more "BookStack" integrated feel, which we'll be able to better utilize in the future:
 
 The new experience switches out our previous usage of the [dropzone.js](https://www.dropzone.dev/) library with a much more lightweight 
 custom implementation to provide a more "BookStack" integrated feel, which we'll be able to better utilize in the future:
 
-TODO - Image upload from image manager here, maybe show error?
+![A screenshot of the BookStack image manager, showing a failed upload containing an error message in red text](/images/2023/05/image-upload-error.png)
 
 This new format for image uploads has the added benefit of now showing errors in a clearer and more accessible format.
 
 
 This new format for image uploads has the added benefit of now showing errors in a clearer and more accessible format.
 
@@ -76,7 +76,7 @@ The styles of the image manager have been tidied and tightened to provide a clea
 The attachment management panel has had a more extensive overhaul, replacing the previous tabbed-based interface
 with a simpler layout that requires less clicks for common upload actions.
 
 The attachment management panel has had a more extensive overhaul, replacing the previous tabbed-based interface
 with a simpler layout that requires less clicks for common upload actions.
 
-TODO - Image of attachment manager here.
+![A view of the attachments area of BookStack with an example uploaded file of a cat](/images/2023/05/attachment-upload.png)
 
 ### Code Block Updating to CodeMirror 6
 
 
 ### Code Block Updating to CodeMirror 6
 
@@ -84,7 +84,7 @@ Within BookStack all code syntax highlighting and code editing, including that o
 After being released last year, I started work to upgrade from CodeMirror 5 to 6 in August of last year, but quickly found this update was essentially a rebuild of the library requiring a lot of work on the BookStack side of things.
 This release cycle I put my head down and spent a lot of time on this so that, as of BookStack v23.05, all such code blocks are now using CodeMirror 6.
 
 After being released last year, I started work to upgrade from CodeMirror 5 to 6 in August of last year, but quickly found this update was essentially a rebuild of the library requiring a lot of work on the BookStack side of things.
 This release cycle I put my head down and spent a lot of time on this so that, as of BookStack v23.05, all such code blocks are now using CodeMirror 6.
 
-TODO - image of CM6 codeblcok?
+![A simple code block within page content, display code syntax highlighting](/images/2023/05/codemirror-6-block.png)
 
 This will hopefully not impact most users, while it should bring us better mobile support while keeping us up-to-date on our libraries.
 This does have some significant impacts to those that had applied customizations, since it changes some of the "Editor Events" we previously had,
 
 This will hopefully not impact most users, while it should bring us better mobile support while keeping us up-to-date on our libraries.
 This does have some significant impacts to those that had applied customizations, since it changes some of the "Editor Events" we previously had,
@@ -95,7 +95,7 @@ See the upgrade notices at the top of the blogpost for more details.
 
 This release brings two new sets of endpoints to the API, helping to fill gaps and empower our API users to achieve all actions possible via the UI.
 
 
 This release brings two new sets of endpoints to the API, helping to fill gaps and empower our API users to achieve all actions possible via the UI.
 
-TODO - Image of endpoints
+![List of the image gallery and content permission API endpoints](/images/2023/05/image-permissions-api-endpoints.png)
 
 The first set are image gallery APIs, which allow the management of page content images much like within the image manager when editing pages. 
 This will be welcome to those that have wanted to handle images in a much more granular way via the API, outside of using the base64-encoded-in-content approach.
 
 The first set are image gallery APIs, which allow the management of page content images much like within the image manager when editing pages. 
 This will be welcome to those that have wanted to handle images in a much more granular way via the API, outside of using the base64-encoded-in-content approach.
@@ -118,7 +118,7 @@ Thanks to [@jasonF1000](https://github.com/BookStackApp/BookStack/pull/4192) for
 Another new coding language gets highlighting support in this release, with
 the lucky language being clojure:
 
 Another new coding language gets highlighting support in this release, with
 the lucky language being clojure:
 
-TODO - Image of clojure code
+![BookStack WYSIWYG code editor showing Clojure syntax highlighting](/images/2023/05/clojure-code-syntax.png)
 
 ### OIDC ID Token Logical Theme Event
 
 
 ### OIDC ID Token Logical Theme Event
 
index 8f7c03c27e5a5c019719c8652e52966e9c78ce1d..04f43d4697ccb6395d3ede315d8fcf8071002eef 100644 (file)
@@ -9,9 +9,7 @@ aliases = ["email-config"]
 Within BookStack email is used in various ways relating to user management & authentication. 
 Outgoing webhooks are available as a mechanism to extend BookStack or notify in an event-driven manner.
 
 Within BookStack email is used in various ways relating to user management & authentication. 
 Outgoing webhooks are available as a mechanism to extend BookStack or notify in an event-driven manner.
 
-- [Email Configuration](#email-configuration)
-- [Outgoing Webhooks](#outgoing-webhooks)
-- [Async Action Handling](#async-action-handling)
+{{<toc>}}
 
 ---
 
 
 ---
 
 
 # The "from" name used for outgoing email
 MAIL_FROM_NAME=BookStack
 
 # The "from" name used for outgoing email
 MAIL_FROM_NAME=BookStack
+```
+
+##### SSL Certificate Verification
 
 
+In some cases your SMTP server may be using a private/self-signed certificate that would usually fail SSL/TSL verification.
+In these cases its common for that certificate (Or its CA) to be added to the BookStack's host trusted certificate database.
+If that's not possible, you can alternatively disable SSL/TLS certificate verification by adding this setting to your `.env` file:
+
+```bash
 # Verify SSL/TLS certificates during SMTP sending
 # Verify SSL/TLS certificates during SMTP sending
-# This option is set to 'true' by default.
-# Set to 'false' to ignore SSL/TLS cert verification.
-# Using 'false' can make you vulnerable to MITM attacks.
-MAIL_VERIFY_SSL=true
+# WARNING: Disabling verification using a 'false' value 
+# can make you vulnerable to MITM attacks
+MAIL_VERIFY_SSL=false
 ```
 
 #### Sendmail
 ```
 
 #### Sendmail
index 0d678727fd55b2cd7353f2907cb63b548761fab2..252cdcf03dab22e0a527c3e76877231501a8f392 100644 (file)
@@ -33,7 +33,7 @@ BookStack has a built-in REST API for external interaction and consumption of yo
 
 ### Custom HTML Head Option
 
 
 ### Custom HTML Head Option
 
-Within the customization settings area you'll find a "Custom HTML head content" setting. You can use this to add in any custom JavaScript or CSS content which enables you to override default BookStack functionality and styles.
+Within the "Settings > Customization" view within BookStack you'll find a "Custom HTML Head Content" setting. You can use this to add in any custom JavaScript or CSS content which enables you to override default BookStack functionality and styles.
 
 You can find examples of custom HTML Head customizations on the [hacks part of this site](/hacks/).
 
 
 You can find examples of custom HTML Head customizations on the [hacks part of this site](/hacks/).
 
@@ -62,15 +62,15 @@ You can find examples of logical theme system customizations on the [hacks part
 
 ---
 
 
 ---
 
-### BookStack JavaScript Public Events
-
 <a id="bookstack-editor-events" data-info="Anchor here for backwards compatibility of existing links"></a>
 
 <a id="bookstack-editor-events" data-info="Anchor here for backwards compatibility of existing links"></a>
 
+### BookStack JavaScript Public Events
+
 To allow customization of the JavaScript libraries & components used, BookStack emits events as part of their lifecycle
 To allow customization of the JavaScript libraries & components used, BookStack emits events as part of their lifecycle
-so that you can define listeners to hook into these events. These can often be used by adding custom scripts to the 
+so that you can define listeners to hook into these events. These can often be used by adding scripts to the 
 [custom HTML head content option](#custom-html-head-option).
 
 [custom HTML head content option](#custom-html-head-option).
 
-You can find details of a listing of all events [within the project repo here](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md).
+You can find details and a listing of all events [within the project repo here](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md).
 
 ---
 
 
 ---
 
index 69aa4e65ffc2fdc6d198227a101c84a397b289d6..7c59d0f123507ec3b3a890756f4f0f991b1f1eac 100644 (file)
@@ -5,7 +5,7 @@ date = "2017-08-22"
 type = "admin-doc"
 +++
 
 type = "admin-doc"
 +++
 
-You may find you want to customise BookStack to use custom branding or you may just not like the default blue theme. Customising the branding of BookStack is super simple and can be done through the "Settings > Customization" area of BookStack. Here you can change the application name, logo and the core colours used. Additional ways to customise are listed below:
+You may want to customise BookStack to use custom branding, or you may just not like the default blue theme. Customising the branding of BookStack is super simple and can be done within the "Settings > Customization" area of the interface. Here you can change the application name, logo and the core colours used. Additional ways to customise are listed below:
 
 {{<toc>}}
 
 
 {{<toc>}}
 
@@ -40,15 +40,15 @@ body, button, input, select, label, textarea {
 </style>
 ```
 
 </style>
 ```
 
-Note that this won't change anything in the settings screen for stability purposes.
+Note that this won't change anything while viewing the settings screen, for stability purposes.
 
 ### Changing Code Block Themes
 
 
 ### Changing Code Block Themes
 
-When inserting code into a page or when using the Markdown editor, the text you enter is highlighted by the [CodeMirror library](https://codemirror.net/).
+When inserting code into a page, or when using the Markdown editor, the text you enter is highlighted by the [CodeMirror library](https://codemirror.net/).
 For those that'd prefer a different colour scheme for code blocks, we do provide a custom `library-cm6::configure-theme` JavaScript event 
 For those that'd prefer a different colour scheme for code blocks, we do provide a custom `library-cm6::configure-theme` JavaScript event 
-that provides a couple of methods that allow registration of CodeMirror UI and syntax highlight themes.
+which provides a couple of methods that allow registration of CodeMirror UI and syntax highlighting themes.
 
 
-You can find more information, along with an example, [in our JavaScript public events documentation here](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md#library-cm6configure-theme).
+You can find more information, along with an example, in our [JavaScript public events documentation here](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md#library-cm6configure-theme).
 
 ### Default Light/Dark Mode
 
 
 ### Default Light/Dark Mode
 
index 72a52bf36dec5096b10050e9faa85abdd3706f9e..1702c863ea42770f4c7ceaa2ea940dbcf3bdaada 100644 (file)
@@ -15,10 +15,10 @@ Within BookStack you may find that you want to include the same block of content
 
 Here are some things to consider when reusing page content via include tags:
 
 
 Here are some things to consider when reusing page content via include tags:
 
-- Permissions are enforced upon includes, so content will only be included from pages that the current user has permission to view.
-- This works up to three levels of nesting, to ensure system performance and to prevent issues of recursion.
-- Included content won't be shown within content preview text/snippets.
-- Included content won't be indexed as searchable content for a page.
+- Permissions are enforced upon includes, so content will only be included from pages that the current user has permission to view. Includes are not obvious nor transparent when viewing a page so it could be easy for a user to externally share content, containing permission-controlled included content, with a non-privileged user without thinking about what permission controls may be in use.
+- Includes work with up to three levels of nesting, limited to ensure system performance and to prevent recursion issues.
+- Included content won't be indexed as searchable content for pages they're included into.
+- Included content won't be shown within content preview text or snippets.
 
 ### Include Tags
 
 
 ### Include Tags
 
diff --git a/static/images/2023/05/attachment-upload.png b/static/images/2023/05/attachment-upload.png
new file mode 100644 (file)
index 0000000..582fbf4
--- /dev/null
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:207c70a24210ad6d599de6b3096ec21b1aa8b8612bdf18acdfce24222f307660
+size 66569
diff --git a/static/images/2023/05/clojure-code-syntax.png b/static/images/2023/05/clojure-code-syntax.png
new file mode 100644 (file)
index 0000000..2150dbf
--- /dev/null
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0d64bcc115a482b3e489ab50548e7396e84a6c252b09112535285cd312de0489
+size 50825
diff --git a/static/images/2023/05/codemirror-6-block.png b/static/images/2023/05/codemirror-6-block.png
new file mode 100644 (file)
index 0000000..2a3ba04
--- /dev/null
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:26867a675c1f8cf9a5454b79712eac35f41fa873c5798e42b7bae44ed6e89f8d
+size 57894
diff --git a/static/images/2023/05/image-permissions-api-endpoints.png b/static/images/2023/05/image-permissions-api-endpoints.png
new file mode 100644 (file)
index 0000000..f55677d
--- /dev/null
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6fb73815f8bf6851d23bd145a636a964cb357a368dbefdd21295a4cfd7326358
+size 17796
diff --git a/static/images/2023/05/image-upload-error.png b/static/images/2023/05/image-upload-error.png
new file mode 100644 (file)
index 0000000..7846c33
--- /dev/null
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8e9062b417b8a8af2d2d92488ff03cabd1c67dbe7a560d182ecc1aa2457465ab
+size 148240