BookStack Code Mirror - website/blob - content/docs/admin/subdirectory-setup.md

   1 +++
   2 title = "Subdirectory Setup"
   3 description = "How to setup BookStack in a subdirectory"
   4 date = "2018-10-04"
   5 type = "admin-doc"
   6 +++
   7
   8 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.
   9
  10 If you are using Docker you will likely need to look into setting up reverse proxies instead of following the below.
  11
  12 ## Apache Setup
  13
  14 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:
  15
  16 ```bash
  17 sudo a2enmod rewrite
  18 ```
  19
  20 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.
  21 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.
  22 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.
  23
  24 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`).
  25
  26 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:
  27
  28 ```apache
  29 <VirtualHost *:80>
  30
  31     ...
  32
  33     # BookStack Configuration
  34     Alias "/bookstack" "/var/www/bookstack/public"
  35
  36     <Directory "/var/www/bookstack/public">
  37       Options FollowSymlinks
  38       AllowOverride None
  39       Require all granted
  40
  41       RewriteEngine On
  42       # Redirect Trailing Slashes If Not A Folder...
  43       RewriteCond %{REQUEST_FILENAME} !-d
  44       RewriteRule ^(.*)/$ /$1 [L,R=301]
  45
  46       # Handle Front Controller...
  47       RewriteCond %{REQUEST_FILENAME} !-d
  48       RewriteCond %{REQUEST_FILENAME} !-f
  49       RewriteRule ^ index.php [L]
  50     </Directory>
  51
  52
  53     <Directory "/var/www/bookstack">
  54       AllowOverride None
  55       Require all denied
  56     </Directory>
  57     # End BookStack Configuration
  58
  59     ...
  60
  61 </VirtualHost>
  62 ```
  63
  64 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.
  65
  66 Once the configuration has been updated, you'll need to restart apache. On Ubuntu you can do this like so:
  67
  68 ```bash
  69 sudo systemctl restart apache2.service
  70 ```
  71
  72 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.
  73
  74
  75 ## BookStack Setup
  76
  77 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:
  78
  79 ```bash
  80 APP_URL=https://example.com/bookstack
  81 ```