bookstack/website
Fork 4
Code Issues 5 Pull requests Activity

Made tweaks to subdirectory setup page

Browse source
This commit is contained in:
Dan Brown 2018-10-06 18:17:57 +01:00
commit b51573706f
Signed by: danb
GPG key ID: 46D9F943C24A2EF9
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
content/docs/admin/subdirectory-setup.md
View file

@ -17,13 +17,13 @@ Before following this, ensure you have apache installed along with PHP & ensure
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.
First, You will need to choose a folder to install BookStack into. 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 install. 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:
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 the middle section:
```apache
<VirtualHost *:80>
@ -61,15 +61,15 @@ Within the `<VirtualHost>` tags of this file you'll need to add the below additi
</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.
On line 6 in the above, beginning with `Alias`, You'll need to change `"/bookstack"` path 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:
Once the configuration has been updated, you'll need to restart apache. On Ubuntu you can do with the following command:
```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.
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