mirror of
https://github.com/AuxXxilium/synology-wireguard.git
synced 2024-11-23 23:11:06 +07:00
103 lines
4.0 KiB
ReStructuredText
103 lines
4.0 KiB
ReStructuredText
WireGuard support for Synology NAS
|
|
==================================
|
|
This package adds WireGuard support for Synology NAS drives. It provides the
|
|
WireGuard kernel module and the ``wg``/``wg-quick`` commands.
|
|
|
|
|
|
Disclaimer
|
|
----------
|
|
You use everything here at your own risk. I am not responsible if this breaks
|
|
your NAS. Realistically it should not result in data loss, but it could render
|
|
your NAS unaccessible if something goes wrong.
|
|
|
|
If you are not comfortable with removing your drives from the NAS and manually
|
|
recover the data, this might not be for you.
|
|
|
|
|
|
Compatibility list
|
|
------------------
|
|
The following drives have been tested:
|
|
|
|
========= ========= =========== ===========================
|
|
Model Platform DSM Version Is working?
|
|
--------- --------- ----------- ---------------------------
|
|
DS114 armada370 *N/A* No (Kernel version too old)
|
|
DS115j armada370 *N/A* No (Kernel version too old)
|
|
DS213j armada370 *N/A* No (Kernel version too old)
|
|
DS213j armada370 *N/A* No (Kernel version too old)
|
|
DS214play armada370 *N/A* No (Kernel version too old)
|
|
DS214se armada370 *N/A* No (Kernel version too old)
|
|
DS216se armada370 *N/A* No (Kernel version too old)
|
|
DS218j armada38x 6.2 Yes
|
|
DS414slim armada370 *N/A* No (Kernel version too old)
|
|
RS214 armada370 *N/A* No (Kernel version too old)
|
|
========= ========= =========== ===========================
|
|
|
|
The minimum required kernel version is 3.10. If you have a kernel version lower
|
|
than that, WireGuard will not work. You can check your kernel version by
|
|
logging in through SSH and running the ``uname -a`` command.
|
|
|
|
|
|
Installation
|
|
------------
|
|
Check the `releases <https://github.com/runfalk/synology-wireguard/releases>`_
|
|
page for SPKs for your platform. If there is no SPK you have to compile it
|
|
yourself using the instructions below.
|
|
|
|
1. In the Synology DSM web admin UI, open the Package Center and press the
|
|
*Settings* button.
|
|
2. Set the trust level to *Any publisher* and press *OK* to confirm.
|
|
3. Press the *Manual install* button and provide the SPK file. Follow the
|
|
instructions until done.
|
|
|
|
Now you just need to figure out how to configure WireGuard. There are lots of
|
|
good guides on how to do that.
|
|
|
|
To put my WireGuard configuration on the NAS, I used SSH and created a
|
|
``wg-quick`` configuration in ``/etc/wireguard/wg0.conf``. Then I opened the
|
|
*Control panel*, opened the *Task scheduler* and created *Triggered task* that
|
|
runs ``wg-quick up wg0`` on startup.
|
|
|
|
|
|
Compiling
|
|
---------
|
|
I've used docker to compile everything, as ``pkgscripts-ng`` clutters the file
|
|
system quite a bit. First create a docker image by running the following
|
|
command in this repository:
|
|
|
|
.. code-block:: bash
|
|
|
|
git clone https://github.com/runfalk/synology-wireguard.git
|
|
cd synology-wireguard/
|
|
sudo docker build -t synobuild .
|
|
|
|
Now we can build for any platform and DSM version using:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo docker run --rm --privileged --env PACKAGE_ARCH=<arch> --env DSM_VER=<dsm-ver> -v $(pwd)/artifacts:/result_spk synobuild
|
|
|
|
You should replace ``<arch>`` with your NAS's package arch. Using
|
|
`this table <https://www.synology.com/en-global/knowledgebase/DSM/tutorial/General/What_kind_of_CPU_does_my_NAS_have>`_
|
|
you can figure out which one to use. Note that the package arch must be
|
|
lowercase. ``<dsm-ver>`` should be replaced with the version of DSM you are
|
|
compiling for.
|
|
|
|
For the DS218j that I have, the complete command looks like this:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo docker run --rm --privileged --env PACKAGE_ARCH=armada38x --env DSM_VER=6.2 -v $(pwd)/artifacts:/result_spk synobuild
|
|
|
|
If everything worked you should have a directory called ``artifacts`` that
|
|
contains your SPK files.
|
|
|
|
|
|
Credits
|
|
-------
|
|
I based a lot of this work on
|
|
`this guide <https://www.reddit.com/r/synology/comments/a2erre/guide_intermediate_how_to_install_wireguard_vpn/>`_
|
|
by Reddit user `akhener <https://www.reddit.com/user/akhener>`_. However, I had
|
|
to modify their instructions a lot since my NAS has an ARM CPU which made cross
|
|
compilation a lot trickier.
|