Added subdirectory setup docs

diff --git a/content/docs/admin/subdirectory-setup.md b/content/docs/admin/subdirectory-setup.md
new file mode 100644 (file)
index 0000000..fc335aa
--- /dev/null
+++ b/content/docs/admin/subdirectory-setup.md
@@ -0,0 +1,81 @@
++++
+title = "Subdirectory Setup"
+description = "How to setup BookStack in a subdirectory"
+date = "2018-10-04"
+type = "admin-doc"
++++
+
+You may want to host BookStack on a "Subdirectory" of your website, For example `https://example.com/bookstack`. To achieve this you will need to make some alterations to your webserver config. The details for setting this up on Apache can be found below. You'll need to follow the BookStack setup section after configuring any webserver.
+
+If you are using Docker you will likely need to look into setting up reverse proxies instead of following the below.
+
+## Apache Setup
+
+Before following this, ensure you have apache installed along with PHP & ensure mod-php is enabled. This guide assumes a recent Ubuntu-like system is in use. To set-up the required rules, you will need to have mod-rewrite enabled:
+
+```bash
+sudo a2enmod rewrite
+``` 
+
+First, You will need to choose a folder to install BookStack. This should a separate directory from where your main website is being served from since you don't want to risk exposing any of the private BookStack files.
+By default Apache on Ubuntu serves from the `/var/www/html` directory. In this example, we'll use `/var/www/bookstack` to store our BookStack files. If you use a different path ensure you change that path in the below steps.
+Create this directory and follow the standard [BookStack install steps](/docs/admin/installation) to install BookStack into this folder. Once complete, following our example directory above, you should end up with a `.env` file in the `/var/www/bookstack` folder.
+
+The next step is to alter your Apache configuration to serve any requests to your sub-path from our chosen folder. To do this you'll need to find and edit the Apache virtual-host config for your website. By default, this is often found at `/etc/apache2/sites-available/000-default.conf`. To edit this file you'll likely have to open it with admin permissions (using `sudo`). 
+
+Within the `<VirtualHost>` tags of this file you'll need to add the below additional configuration. Note, the `<VirtualHost>` tags should already exist and the `...` parts represent existing rules. You should only need to copy out the middle part:
+
+```apache
+<VirtualHost *:80>
+
+    ...
+
+    # BookStack Configuration
+    Alias "/bookstack" "/var/www/bookstack/public"
+
+    <Directory "/var/www/bookstack/public">
+      Options FollowSymlinks
+      AllowOverride None
+      Require all granted
+
+      RewriteEngine On
+      # Redirect Trailing Slashes If Not A Folder...
+      RewriteCond %{REQUEST_FILENAME} !-d
+      RewriteRule ^(.*)/$ /$1 [L,R=301]
+
+      # Handle Front Controller...
+      RewriteCond %{REQUEST_FILENAME} !-d
+      RewriteCond %{REQUEST_FILENAME} !-f
+      RewriteRule ^ index.php [L]
+    </Directory>
+
+
+    <Directory "/var/www/bookstack">
+      AllowOverride None
+      Require all denied
+    </Directory>
+    # End BookStack Configuration
+
+    ...
+
+</VirtualHost>
+``` 
+
+Within the first line of the above, You'll need to change `"/bookstack"` to be the web 'subdirectory' you want to serve BookStack on. For example, If you wanted to serve BookStack on `https://example.com/docs` this would be `"/docs"`. Any instances of `/var/www/bookstack` in the above will need to be changed to the folder you installed BookStack in. The `/public` part of these paths should remain.
+
+Once the configuration has been updated, you'll need to restart apache. On Ubuntu you can do this like so:
+
+```bash
+sudo systemctl restart apache2.service
+```
+
+Follow the below "BookStack Setup" to add your new URL to your bookstack configuration. Once done you should be able to access your BookStack instance at your desired sub-path.
+
+
+## BookStack Setup
+
+Within your `.env` file ensure you set the `APP_URL` parameter. This should be the base URL for your BookStack instance without a trailing slash. For example:
+
+```bash
+APP_URL=https://example.com/bookstack
+```
\ No newline at end of file

diff --git a/themes/bookstack/layouts/partials/menu_admin_docs.html b/themes/bookstack/layouts/partials/menu_admin_docs.html
index b5c02aadfe2a774360c9fb3ddf4272816b07df6a..f4af6e35c336b36faee3f4b662d08fd8acce4101 100644 (file)
--- a/themes/bookstack/layouts/partials/menu_admin_docs.html
+++ b/themes/bookstack/layouts/partials/menu_admin_docs.html
@@ -5,6 +5,7 @@
        <li><a href="/docs/admin/security">Security</a></li>
        <li><a href="/docs/admin/upload-limits">Changing Upload Limits</a></li>
        <li><a href="/docs/admin/multi-instance">Multiple Instances</a></li>
+       <li><a href="/docs/admin/subdirectory-setup">Subdirectory Setup</a></li>
 </ul>
 
 <h4>Maintenance</h4>

diff --git a/themes/bookstack/static/js/script.js b/themes/bookstack/static/js/script.js
index 1650b5b653e353aec59f8823faf67930c58f8272..c10e883b802167859ecfd58e0fd7f0cf313182b1 100644 (file)
--- a/themes/bookstack/static/js/script.js
+++ b/themes/bookstack/static/js/script.js
@@ -41,7 +41,7 @@ var modeMap = {
   'language-js': 'javascript',
   'language-shell': 'bash',
   'language-nginx': 'nginx',
-  'language-apache': 'xml'
+  'language-apache': 'apache'
 };
 
 var codeBlocks = document.querySelectorAll('pre');
@@ -52,6 +52,7 @@ for (var i = 0; i < codeBlocks.length; i++) {
 
   var langClass = codeElem.className;
   var mode = (typeof modeMap[langClass] !== 'undefined') ? modeMap[langClass] : 'htmlmixed';
+  console.log(mode);
   var content = codeElem.textContent.trim();
   CodeMirror(function(cmElem) {
     block.parentNode.replaceChild(cmElem, block);