title = "Backup and Restore"
description = "How to back up and restore your BookStack data"
date = "2017-01-01"
-type = "admin-docs"
+type = "admin-doc"
+++
BookStack does not currently have a built-in way to backup and restore but it
title = "Cache & Session Configuration"
description = "Cache & Session setup with details for redis and memcached"
date = "2017-01-01"
-type = "admin-docs"
+type = "admin-doc"
+++
By default BookStack will use a file system cache that's storage in the `storage/framework` folder. This is also used to store user session data. Below are some alternative systems that can be used for caching & sessions.
title = "Commands"
description = "BookStack command-line actions"
date = "2017-02-26"
-type = "admin-docs"
+type = "admin-doc"
+++
BookStack has some command line actions that can help with maintenance and common operations. There are also many commands available from the underlying Laravel framework. To list all available commands you can simply run `php artisan` from your BookStack install folder. Custom BookStack commands are all under the 'bookstack' namespace.
title = "Debugging Errors"
description = "How to find the cause of issues in BookStack"
date = "2017-01-01"
-type = "admin-docs"
+type = "admin-doc"
+++
When using BookStack, Especially when initially setting it up or after updating, you may come across some errors. While we try to reduce these as much as possible and make them helpful sometimes you may come across a bland and non-helpful 'An error has occurred' message. This is to prevent any potentially sensitive information being shown to all users.
title = "Installation"
description = "How to install BookStack"
date = "2017-01-01"
-type = "admin-docs"
+type = "admin-doc"
+++
Below are some different methods of installing BookStack. If you cannot find a guide for your setup search the web for "Laravel install guides" relevant for your system as the process is mostly the same.
title = "LDAP Authentication"
description = "How to use LDAP as your primary way to register and login to BookStack"
date = "2017-01-21"
-type = "admin-docs"
+type = "admin-doc"
+++
BookStack can be configured to allow LDAP based user login. While LDAP login is enabled you cannot log in with the standard user/password login and new user registration is disabled. BookStack will only use the LDAP server for getting user details and for authentication. Data on the LDAP server is not currently editable through BookStack.
title = "Multiple BookStack Instances"
description = "How to host multiple BookStack instances on Apache and Nginx"
date = "2017-01-01"
-type = "admin-docs"
+type = "admin-doc"
+++
Currently BookStack does not support multiple instances from one installation but you can set up multiple instances on the same server by creating multiple installations and configuring your web-server appropriately.
title = "PDF Rendering"
description = "Using WKHTMLtoPDF to generate PDF's for better rendering"
date = "2017-01-22"
-type = "admin-docs"
+type = "admin-doc"
+++
By default BookStack uses [Dompdf](https://github.com/dompdf/dompdf) to export pages as PDF documents. The benefit of using DomPDF is that it doesn't require any additional installation or setup but the rendering capabilities are somewhat limited.
title = "Security"
description = "BookStack security concerns and considerations"
date = "2017-01-01"
-type = "admin-docs"
+type = "admin-doc"
+++
Since BookStack can hold important information for users you should be aware of any potential security concerns.
title = "Social Authentication"
description = "Enabling and configuring social authentication for easier logins"
date = "2017-01-01"
-type = "admin-docs"
+type = "admin-doc"
+++
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:
title = "Updating BookStack"
description = "How to update BookStack to the lastest version"
date = "2017-01-01"
-type = "admin-docs"
+type = "admin-doc"
+++
BookStack is updated regularly and is still in beta although we do try to keep the platform and upgrade path as stable as possible. The latest release can be found on [GitHub here](https://github.com/BookStackApp/BookStack/releases) and detailed information on releases is posted on the [BookStack blog here](https://www.bookstackapp.com/blog/tag/releases/).
title = "Changing Upload Limits"
description = "How to increase uploads limits for images and attachments"
date = "2017-01-01"
-type = "admin-docs"
+type = "admin-doc"
+++
BookStack allows users to upload both images for content and files as attachments. By default, a lot of server software has strict limits on upload sizes which causes errors when users upload new content. This is not configured as part of BookStack but as part of PHP and your web sever software. If you run into problems with upload size limits follow the below details for PHP and whichever web server you use:
title = "UTF8mb4/Emoji Support"
description = "Adding UTF8mb4 support to allow use of emoji in content"
date = "2017-01-01"
-type = "admin-docs"
+type = "admin-doc"
slug = "ut8mb4-support"
+++
title = "Customising BookStack"
description = "Changing the colors, logo and styles of BookStack to suit your needs"
date = "2017-08-22"
-type = "admin-docs"
+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 interface under 'App Settings'. Here you can change the application name, logo and primary color.
title = "Content Overview"
description = "Overview of BookStack content objects and data types"
date = "2017-01-01"
-type = "user-docs"
+type = "user-doc"
+++
The principles of storing information within BookStack is based of the ideas of a normal stack of books. Just like normal books, BookStack books can contain chapters and pages. You start off by creating a book which acts as the highest level of categorisation. Ideally you'd have separate books for separate topics. Within a book you can directly create pages or you can first create chapters. Chapters provide an additional level of page grouping to keep pages organised but are optional. All the information you write is held within pages. Although books and chapters do not hold information they can be given a short description to assist with searching and visibility.
title = "Markdown Editor"
description = "Details on using the markdown editor in BookStack"
date = "2017-07-28"
-type = "user-docs"
+type = "user-doc"
+++
If you prefer the write in Markdown the editor in BookStack can be changed at a instance level
title = "Organising Content"
description = "How to organise and sort books, chapters and pages in BookStack"
date = "2017-01-01"
-type = "user-docs"
+type = "user-doc"
+++
Once your BookStack instance starts to grow you will find that you may want to re-organise your content. Within BookStack there are two options for moving content around; Either you can move pages and chapters individually or you can sort entire books.
title = "Reusing Page Content"
description = "How to use include tags to reuse pages and page content within other pages"
date = "2017-01-22"
-type = "user-docs"
+type = "user-doc"
slug = "reusing-page-content"
+++
title = "Searching Content"
description = "Searching for specific content within BookStack and learning the advanced search syntax"
date = "2017-04-16"
-type = "user-docs"
+type = "user-doc"
+++
The ability to search your documentation is vital to day-to-day use.
title = "Default Page Editor"
description = "Details on the standard Page editor in BookStack"
date = "2017-07-28"
-type = "user-docs"
+type = "user-doc"
+++
The default editor in BookStack is a 'What You See Is What You Get' (WYSIWYG) editor.
<div class="container">
<div class="row">
<div class="col-sm-6">
- {{ if eq .Type "admin-docs" }}
+ {{ if eq .Type "admin-doc" }}
<h2 class="thin-margin">Admin Documentation</h2>
{{end}}
- {{ if eq .Type "user-docs" }}
+ {{ if eq .Type "user-doc" }}
<h2 class="thin-margin">User Documentation</h2>
{{end}}
</div>
<div class="row">
<div class="col-sm-2 sidebar">
- {{ if eq .Type "admin-docs" }}
+ {{ if eq .Type "admin-doc" }}
{{partial "menu_admin_docs"}}
{{end}}
- {{ if eq .Type "user-docs" }}
+ {{ if eq .Type "user-doc" }}
{{partial "menu_user_docs"}}
{{end}}
</div>
<div class="container">
<div class="row">
<div class="col-sm-6">
+ {{if eq .Page.Type "admin-doc"}}
+ <h2 class="thin-margin">Admin Documentation</h2>
+ {{else if eq .Page.Type "user-doc"}}
+ <h2 class="thin-margin">User Documentation</h2>
+ {{else}}
<h2 class="thin-margin">Documentation</h2>
+ {{end}}
+
+
</div>
<div class="col-sm-6">
<div class="float right float-none-sm">
<div class="container">
<div class="row docs-index">
+
+ {{if ne .Page.Type "user-doc"}}
<div class="col-sm-6">
<div class="shaded padded">
+ {{if ne .Page.Type "admin-doc"}}
<h3>Admin Documentation</h3>
+ {{end}}
{{partial "menu_admin_docs"}}
</div>
</div>
+ {{end}}
+ {{if ne .Page.Type "admin-doc"}}
<div class="col-sm-6">
<div class="shaded padded">
+ {{if ne .Page.Type "user-doc"}}
<h3>User Documentation</h3>
+ {{end}}
{{partial "menu_user_docs"}}
</div>
</div>
+ {{end}}
</div>
</div>
+<p><br></p>
+
{{ partial "footer.html" . }}
\ No newline at end of file
projects / website / commitdiff