diff --git a/howtos.rst b/howtos.rst index b792d374..e9924dcb 100644 --- a/howtos.rst +++ b/howtos.rst @@ -5,6 +5,7 @@ How-tos & Guides .. toctree:: :maxdepth: 2 + howtos/tailscale_install howtos/stable_kernel_backport howtos/15-2_to_15-3 howtos/15-3_to_15-4 diff --git a/howtos/tailscale_install.rst b/howtos/tailscale_install.rst new file mode 100644 index 00000000..9528b36b --- /dev/null +++ b/howtos/tailscale_install.rst @@ -0,0 +1,77 @@ +.. _install_tailscale: + +Tailscale install +================= + +This How-to covers only the installation of the `Tailscale `_ cloud service program. + +.. note:: + + Once installed, see our :ref:`Tailscale service ` + documentation for configuration and use. + +.. _install_tailscale_upstream: + +Upstream instructions +--------------------- + +This How-to is derived from, and secondary to, +the canonical upstream instructions as provided by `Tailscale `_ themselves. +It is intended only to assist in providing relevant links and light guidance. + +.. note:: + + Rockstor is "Built on openSUSE", specifically **openSUSE Leap** or **Tumbleweed**: depending on the installer used. + Our Tailscale service integration requires only that a recent Tailscale instance be installed. + The Tailscale `Stable` variant is advised but not assumed. + + +.. _install_tailscale_upstream_leap: + +Built on openSUSE Leap +^^^^^^^^^^^^^^^^^^^^^^ +Installs derived from our Leap based `downloadable installers `_. + +.. warning:: + + As of this How-to's publication, tailscale does not yet provide Leap 15.6 repositories. + Until Tailscale resolves this situation, consider using their 15.5 repository in the interim period. + Also note that their `Downloads` -> `Linux` -> `Manually install on ...` **dropdown** is + now years **out-of-date**. **Reference instead the following more maintained instructions.** + +- `Setting up Tailscale on openSUSE Leap `_ + +.. note:: + + Replace $VERSION in the above instructions with your base OS Leap version. + +E.g. for Leap 15.6 (using the 15.5 repo instead): + +.. code-block:: console + + sudo rpm --import https://pkgs.tailscale.com/stable/opensuse/leap/15.5/repo.gpg + sudo zypper ar -g -r https://pkgs.tailscale.com/stable/opensuse/leap/15.5/tailscale.repo + sudo zypper ref + sudo zypper in tailscale + +**Continue service enablement & configuration via our Web-UI** :ref:`Tailscale service ` intergration. + +.. _install_tailscale_upstream_tumbleweed: + +Built on openSUSE Tumbleweed +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Installs derived from our Tumbleweed based `downloadable installers `_. + +- `Setting up Tailscale on openSUSE Tumbleweed `_ + +E.g. + +.. code-block:: console + + sudo rpm --import https://pkgs.tailscale.com/stable/opensuse/tumbleweed/repo.gpg + sudo zypper ar -g -r https://pkgs.tailscale.com/stable/opensuse/tumbleweed/tailscale.repo + sudo zypper ref + sudo zypper in tailscale + +**Continue service enablement & configuration via our Web-UI** :ref:`Tailscale service ` intergration. + diff --git a/interface/system/services.rst b/interface/system/services.rst index 50289a37..ccc20f07 100644 --- a/interface/system/services.rst +++ b/interface/system/services.rst @@ -296,8 +296,15 @@ The SNMP service can now be turned ON by toggling the ON/OFF switch located to i Tailscale --------- -Starting in version 5.0.5-0, Rockstor provides an easy integration of the `Tailscale `_ service. -Tailscale is a private mesh VPN using `Wireguard `_ allowing, for instance, to connect remote machines as if they were on the same private network. +From Rockstor version 5.0.5-0 `Tailscale `_ is natively supported. +However the required Tailscale program is intentionally **NOT pre-installed**. + +.. warning:: + + A :ref:`install_tailscale` is required before configuration or use. + +Tailscale is a private mesh VPN using `Wireguard `_ allowing, for instance, +to connect remote machines as if they were on the same private network. This service can thus provide an easy solution to remotely access your Rockstor instances and/or their :ref:`File sharing `. .. note::