Skip to content

Commit

Permalink
Documentation for Synology NAS hosting. (#26)
Browse files Browse the repository at this point in the history
* Add Synology hosting documentation.

* Correct SYnology documentation numbering.

* Correct wrongly formated link.

* Correct image placement.

* Correct angle brackets.

* Fix list elements.

* Clean MariaDB10 image (red dots were appearing on it...).

* Add missing WS-DataFolderRights.png image.

* Make sure neither xdebug nor display_error are selected.
  • Loading branch information
yann64 authored Jan 12, 2021
1 parent e765da8 commit 6e21aae
Show file tree
Hide file tree
Showing 13 changed files with 131 additions and 0 deletions.
1 change: 1 addition & 0 deletions _install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ things you should know.
* [MAMP]({% link _install/mamp.md %})
* [Microsoft/IIS]({% link _install/iis.md %})
* [OVH]({% link _install/ovh.md %})
* [Synology]({% link _install/synology.md %})
* [XAMPP]({% link _install/xampp.md %})

## Third-party installers
Expand Down
130 changes: 130 additions & 0 deletions _install/synology.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
---
layout: documentation
title: Synology NAS hosting
date: 2021-01-10
order: 99
---

This procedure if for Synology NAS running DiskStation Manager (DSM) version 6.X.

# Pre-requisites

## Packages Installation

Open the DiskStation Manager interface. Use the Package Center to install the following packages (note they may already be installed):
* Web Station
* MariaDB 10
* phpMyAdmin (only required for initial set-up of the database, may be removed once Webtrees is running).

## Webstation configuration

1. In DSM, open "Web Station".
2. Click on "General Setting" and check which PHP profile is being used ("Default PHP 7.4" in the below example):

![Click on General Settings, check PHP profile.](../assets/img/synology/WS-GeneralSettings.png)

3. Click on "PHP Settings" then select the the PHP profile used by Web Station:

![Click on PHP Settings, select default PHP profile.](../assets/img/synology/WS-PHPSettings.png)

4. Edit the selected PHP profile, make sure
- all extensions are activated in the Extensions list.
- neither "Enable Xdebug" nor "Enable display_errors to display PHP error messages" are selected.

![Edit the default PHP profile, activate all extensions.](../assets/img/synology/WS-PHPProfileSettings.png)

5. Click "OK".
## MySQL/MariaDB configuration

### Confirm MySQL/MariaDB server port

6. In DSM, open "MariaDB 10".
7. Check/confirm which port MariaDB is running on. Default is 3307.

![Check the MariaDB 10 port. Default is 3307 on Synology NAS.](../assets/img/synology/WS-MariaDBSettings.png)

### MariaDB user and database configuration

8. In DSM, open "phpMyAdmin", and log-in using a profile allowed to create databases and profiles/users (e.g. "root").
9. Click on "User account", then click on "Add user account":

![Add a user account.](../assets/img/synology/WS-MariaUserAccounts.png)

10. Choose the database sessings:
- "User name" will be both the user name and the database name. **Note it in order not to forget it!**
- "Host name" must be set to "localhost" for safety reasons.
- Generating a complex/random password is recommended. **Note it in order not to forget it!**
- Tick "Create database with same name and grant all privileges."

![Recommended user settings.](../assets/img/synology/WS-MariaUserAccountsSettings.png)

11. Click "Go" at the bottom right to generate both the user and its associated database.

# Webtrees installation

## Moving the files to your NAS

12. Synology NAS come with PHP >= 7.1, so you will have to download [webtrees-{{ site.latest_version }}.zip][DOWNLOAD].
13. Unpack this file on your computer. You should have a folder called `webtrees`.
14. On you NAS, open "File Station", navigate to your `web` folder.
15. Create a `webtrees` folder (or any other name) inside your .
16. Drag and drop the content the `webtrees` folder on your computer in the `webtrees` folder created at step 4 ("File Station" supports multiple files and folders drag and drop).

![Drag and drop Webtrees files into File Station.](../assets/img/synology/WS-MoveWebtreesFiles.png)

## Setting main folder rights

17. Still in "File Station", right click on the `webtrees` (or any other name) folder you created at step 4, then click on "Properties". Click on the "Permission" tab.
18. Click on "Create", then fill the "Permission Editor" window (this will allow Webtrees to automatically update):
- User of group: http
- Inherit from: \<None\>
- Type: Allow
- Apply to: All
- Leave "Administration" unticked.
- Do not select anything in "Administration" rights.
- Select everything for "Read" rights.
- Select everything but "Delete" for "Write" rights.

![Main folder rights.](../assets/img/synology/WS-MainFolderRights.png)

- Once done click "OK".
19. Select "Apply to this folder, sub-folders and files", then click "OK".

![Main folder properties.](../assets/img/synology/WS-MainFolderProperties.png)

## Setting main folder rights

20. Still in "File Station", right click on the `data` sub-folder of your webtrees install folder, then click on "Properties". Click on the "Permission" tab.
21. Click on "Create", then fill the "Permission Editor" window (this will allow Webtrees to automatically update):
- User of group: http
- Inherit from: <None>
- Type: Allow
- Apply to: All
- Leave "Administration" unticked.
- Do not select anything in "Administration" rights.
- Select everything for "Read" rights.
- Select everything for "Write" rights.

![Main folder rights.](../assets/img/synology/WS-DataFolderRights.png)

- Once done click "OK".
22. Select "Apply to this folder, sub-folders and files", then click "OK".

![Main folder properties.](../assets/img/synology/WS-MainFolderProperties.png)

## Configuring Webtrees

23. Run the webtrees configuration wizard.
24. Once at the "Database connection" step, enter the following settings:
- Server name: 127.0.0.1
- Port number: 3307
- Database user account: the one you noted at step 3.3 of this documentation.
- Database password: the one you noted at step 3.3 of this documentation.
- Database name: identical to the database user account.
- Table prefix: leave "wt_"

![Main folder properties.](../assets/img/synology/WS-MainFolderProperties.png)

25. Last step is to create the user account that will be used as your main Webtrees account.

Any question, post it on the [Webtrees Forum](https://www.webtrees.net/index.php/en/forum).
Binary file added assets/img/synology/WS-DataFolderRights.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/synology/WS-GeneralSettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/synology/WS-MainFolderProperties.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/synology/WS-MainFolderRights.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/synology/WS-MariaDBSettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/synology/WS-MariaUserAccounts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/synology/WS-MoveWebtreesFiles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/synology/WS-PHPProfileSettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/synology/WS-PHPSettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/synology/WT-Wizard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6e21aae

Please sign in to comment.