From d279e8b5087bf6a3004b1e8f51e8920bd84c4684 Mon Sep 17 00:00:00 2001 From: Sebastian Larsen Prehn Date: Wed, 23 Apr 2025 10:57:38 +0200 Subject: [PATCH 1/4] Add information about terms of use --- docs/index.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 1b82895..6e22d0a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -41,6 +41,13 @@ Welcome to the documentation site for ERDA and SIF! `ERDA ` To quickly get started with ERDA or SIF, we recommend our :ref:`Getting Started ` page. If you are looking for something specific, the search functionality and the sidebar on the left is a good way to find what you are looking for! +Make sure to read the terms you agree to when you use ERDA `here `_ and for SIF at the bottom of its `front page `_. + +In short the terms should follow common sense, e.g. it is your responsibility to only store data that you actually have the right to store, and to keep your login safe and secret to prevent others from access to your account. + +.. important:: Please carefully read about data replication and backup in our FAQ on the `front page of ERDA `_ to make sure you are fully aware exactly what we do and don’t offer and what your own responsibilities are regarding data safety. + This is relevant both in regard to our terms of use and fulfilling the requirements of the `mandatory data classification at UCPH `_. + |:file_cabinet:| About ERDA ERDA (Electronic Research Data Archive) at the University of Copenhagen (KU/UCPH) is meant for storing, From 2f7ddbf22a3f7cdea33e8db10b29c78b57f04e31 Mon Sep 17 00:00:00 2001 From: Sebastian Larsen Prehn Date: Wed, 23 Apr 2025 11:10:09 +0200 Subject: [PATCH 2/4] Fix duplicate error --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 6e22d0a..e687c13 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -41,7 +41,7 @@ Welcome to the documentation site for ERDA and SIF! `ERDA ` To quickly get started with ERDA or SIF, we recommend our :ref:`Getting Started ` page. If you are looking for something specific, the search functionality and the sidebar on the left is a good way to find what you are looking for! -Make sure to read the terms you agree to when you use ERDA `here `_ and for SIF at the bottom of its `front page `_. +Make sure to read the `terms `_ you agree to when you use ERDA and for SIF at the bottom of its `front page `_. In short the terms should follow common sense, e.g. it is your responsibility to only store data that you actually have the right to store, and to keep your login safe and secret to prevent others from access to your account. From 840be805d03c1213351f3dc806a875e94a942a9e Mon Sep 17 00:00:00 2001 From: Sebastian Larsen Prehn Date: Tue, 29 Apr 2025 14:50:14 +0200 Subject: [PATCH 3/4] Add networkdrive info for SIF --- docs/index.rst | 1 + docs/sections/sif/networkdrive/index.rst | 82 +++++++++++++++++++ .../sections/sif/networkdrive/sshfs/index.rst | 4 + .../sif/networkdrive/webdavs/index.rst | 4 + .../sif/networkdrive/workarounds/index.rst | 61 ++++++++++++++ 5 files changed, 152 insertions(+) create mode 100644 docs/sections/sif/networkdrive/index.rst create mode 100644 docs/sections/sif/networkdrive/sshfs/index.rst create mode 100644 docs/sections/sif/networkdrive/webdavs/index.rst create mode 100644 docs/sections/sif/networkdrive/workarounds/index.rst diff --git a/docs/index.rst b/docs/index.rst index e687c13..95c046e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -34,6 +34,7 @@ ERDA/SIF: User Guides sections/sif/signup/index sections/sif/project/index + sections/sif/networkdrive/index Welcome to the documentation site for ERDA and SIF! `ERDA `_ and `SIF `_ simplifies storing, sharing, analyzing and archiving research data for KU/UCPH employees, their collaboration partners, and KU/UCPH students. diff --git a/docs/sections/sif/networkdrive/index.rst b/docs/sections/sif/networkdrive/index.rst new file mode 100644 index 0000000..e09df36 --- /dev/null +++ b/docs/sections/sif/networkdrive/index.rst @@ -0,0 +1,82 @@ +.. _sif-networkdrive-start: + +===================== +Efficient Data Access +===================== + +As a SIF user, you can work locally on your cmoputer with your SIF files by connecting SIF as a network drive for efficient and transparently integrated file access through different interfaces. + + +These interfaces allow you to transfer many or big files more efficiently and to map your individual SIF project files and folders on your local PC or workstation. +In that way you can work with them as if they were local files. + + +Please note that the strict SIF project isolation applies to these interfaces as well, so you can only have one project open at a time. +If you have more than one SIF project you configure efficient access for each of them individually. + + +All the interfaces use a secure connection to SIF, so they are accessible from anywhere where you have an Internet connection. +Thus, you do not need VPN or anything like that to access them from outside UCPH. +However, they require you to have an active two-factor authentication session from the same computer for added security. + + ++--------------------+-------------------------------------------------------------------------+ +| 1. WebDAVS | WebDAVS is an abbreviation for Web-based Distributed Authoring | +| | | +| | and Versioning. A "S" is for secure, as it all runs on a | +| | | +| | secure connection. | +| | | +| | β˜‘ Can be used from Windows, Mac and Linux/UNIX | +| | | +| | β˜‘ Easy to get started | +| | | +| | β˜‘ Does not require software installation | +| | | +| | 𐄂 Limit on file size on Windows - 50 MB as a starting point | +| | | +| | 𐄂 Sensitive to network outages | +| | | +| | 𐄂 WebDAVS is less efficient at transferring many and/or large files. | +| | | ++--------------------+-------------------------------------------------------------------------+ +| 2. SSHFS with SFTP | SSHFS is an abbreviation for Secure Shell File System and is the | +| | client | +| | | +| | that connects an SFTP service as a network drive on your | +| | | +| | | +| | computer. SFTP is an abbreviation for Secure File Transfer Protocol. | +| | | +| | β˜‘ Can be used from Windows, Mac and Linux/UNIX | +| | | +| | β˜‘ Efficient handling of many/large files | +| | | +| | β˜‘ Robust regarding network outages | +| | | +| | β˜‘ Unlimited file size | +| | | +| | 𐄂 You have to install two small programs - once | +| | | ++--------------------+-------------------------------------------------------------------------+ + + +.. TIP:: + **We recommend SSHFS with SFTP, particularly for users who feel comfortable with the technology and/or who work intensively with their data.** + +⏩️ :doc:`WebDAVS ` + WebDAVS is a popular protocol to access remote storage using extensions to the HTTP protocol and is the simpler option. + +⏩️ :doc:`SSHFS with SFTP ` + SSHFS with SFTP is another popular option to access remote storage that uses the SSH File Transfer Protocol, and is the more robust, but more complex option. + +⏩️ :doc:`Workarounds ` + Sometimes workarounds are necessary. Those can be found here. + +.. toctree:: + :maxdepth: 3 + :hidden: + + WebDAVS + SSHFS with SFTP + Workarounds diff --git a/docs/sections/sif/networkdrive/sshfs/index.rst b/docs/sections/sif/networkdrive/sshfs/index.rst new file mode 100644 index 0000000..ca231df --- /dev/null +++ b/docs/sections/sif/networkdrive/sshfs/index.rst @@ -0,0 +1,4 @@ +SSHFS +===== + +WIP diff --git a/docs/sections/sif/networkdrive/webdavs/index.rst b/docs/sections/sif/networkdrive/webdavs/index.rst new file mode 100644 index 0000000..91b70ae --- /dev/null +++ b/docs/sections/sif/networkdrive/webdavs/index.rst @@ -0,0 +1,4 @@ +WebDAVS +======= + +WIP diff --git a/docs/sections/sif/networkdrive/workarounds/index.rst b/docs/sections/sif/networkdrive/workarounds/index.rst new file mode 100644 index 0000000..611660d --- /dev/null +++ b/docs/sections/sif/networkdrive/workarounds/index.rst @@ -0,0 +1,61 @@ +=========== +Workarounds +=========== + +Sometimes we need to introduce a workaround either due to limitations in our own systems, or due to how something works at the KU level. Such workarounds are (for now) placed here. + + +SOCK5 connection to SIF +======================= + +This workaround can sometimes be necessary if you cannot get 2FA to work on your remote KU server. +Based on `https://linuxize.com/post/how-to-setup-ssh-socks-tunnel-for-private-browsing `_. + +Prerequisites +------------- + +* Server at KU running any flavor of Linux, with SSH access to route your traffic through it. +* A web browser (Google Chrome, Firefox etc.). +* SSH client. + + +Set up the SSH tunnel +--------------------- + +Linux and MacOS (tested) +^^^^^^^^^^^^^^^^^^^^^^^^ + +Run the following command:: + + ssh -D 9090 [USER]@[SERVER_IP] + +[USER]@[SERVER_IP] - Your remote SSH user and server IP address. + +9090 is simply a port number, and can be configured. + +Configuring your browser to use proxy +------------------------------------- + +Google Chrome (tested) +^^^^^^^^^^^^^^^^^^^^^^ + +**Linux:**:: + + /usr/bin/google-chrome \ + --user-data-dir="$HOME/proxy-profile" \ + --proxy-server="socks5://localhost:9090" + +**MacOS:**:: + + "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome" \ + --user-data-dir="$HOME/proxy-profile" \ + --proxy-server="socks5://localhost:9090" + +**Windows:**:: + + "C:\Program Files (x86)\Google\Chrome\Application\chrome.exe" ^ + --user-data-dir="%USERPROFILE%\proxy-profile" ^ + --proxy-server="socks5://localhost:9090" + + Once open, simply navigate to sif.ku.dk and login. After that, you can use sftp on the machine you SSH'ed to, as you have logged into SIF on that machine through the proxy. + From 6e81eed8c9a837fa739e2882e281152790fa87fb Mon Sep 17 00:00:00 2001 From: Sebastian Larsen Prehn Date: Fri, 2 May 2025 14:54:59 +0200 Subject: [PATCH 4/4] Add WebDAVS guide from old guide #13 --- .../sif/networkdrive/webdavs/index.rst | 27 ++++++++++++++++- .../sif/networkdrive/webdavs/linux.rst | 28 +++++++++++++++++ .../sif/networkdrive/webdavs/macos.rst | 20 +++++++++++++ .../sif/networkdrive/webdavs/windows.rst | 30 +++++++++++++++++++ 4 files changed, 104 insertions(+), 1 deletion(-) create mode 100644 docs/sections/sif/networkdrive/webdavs/linux.rst create mode 100644 docs/sections/sif/networkdrive/webdavs/macos.rst create mode 100644 docs/sections/sif/networkdrive/webdavs/windows.rst diff --git a/docs/sections/sif/networkdrive/webdavs/index.rst b/docs/sections/sif/networkdrive/webdavs/index.rst index 91b70ae..a4a41b3 100644 --- a/docs/sections/sif/networkdrive/webdavs/index.rst +++ b/docs/sections/sif/networkdrive/webdavs/index.rst @@ -1,4 +1,29 @@ WebDAVS ======= -WIP +WebDAV is a popular protocol to access remote storage using extensions to the HTTP protocol, and it can be secured with TLS/SSL in the same way. + + +We refer to this secured version as WebDAVS, and recent versions of Microsoft Windows, MacOS and Linux support this protocol out of the box, so that it is possible to access remote content as if it was in a local folder on your computer. +There is no need to install additional software and you can access your files in a secure fashion. +It should be noted that WebDAVS was built for simple web page publishing, so it is neither particularly efficient for bigger data transfers nor robust against network glitches. +Thus, we genereally recommend looking at one of the SFTP-based solutions, where `SSHFS with SFTP `_ is a popular option if performance and stability is a concern. + +Firstly, you need to go to your **Setup** page at SIF and configure a strong password to enable WebDAVS, and click **Save WebDAVS Settings**. Please note that your Login Details including your automatic login username is shown on that page. + + +Once you have set it up, you can find our guide for Windows, MacOS and Linux linked below. + +⏩️ :doc:`Setup WebDAVS on Windows ` + +⏩️ :doc:`Setup WebDAVS on MacOS ` + +⏩️ :doc:`Setup WebDAVS on MacOS ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + Windows + MacOS + Linux diff --git a/docs/sections/sif/networkdrive/webdavs/linux.rst b/docs/sections/sif/networkdrive/webdavs/linux.rst new file mode 100644 index 0000000..f2b1f18 --- /dev/null +++ b/docs/sections/sif/networkdrive/webdavs/linux.rst @@ -0,0 +1,28 @@ +.. _erda-networkdrive-ldavs: + +Setup WebDAVS on Linux +====================== + +As the nature of Linux is about free choice, we can make no assumptions on what you have available. +Instead, this page will detail what most modern Linux distributions offer in terms of native file manager. +Be it Nautilus, Konqueror, Dolphin, Thunar or something else. + +.. _sif-networkdrive-ldavssetup: + +Linux File Manager +------------------ + +In the file manager menu typically under **Go** you select **Open Location**. + +Enter the server URL from the **WebDAVS** setup tab (possibly replacing *https* with *davs* in the URL if it complains) and click **Connect**. + +In XFCE with the Thunar file manager you need to use the *davs* rather than the *https* prefix in the URL. + + +You will then be prompted for your automatic username and the password you entered on the **WebDAVS** setup tab. +In this case it specified the atuomatic username *yoursifmail@projectName*. + + +On success you will see the remote content. + + diff --git a/docs/sections/sif/networkdrive/webdavs/macos.rst b/docs/sections/sif/networkdrive/webdavs/macos.rst new file mode 100644 index 0000000..2484d2f --- /dev/null +++ b/docs/sections/sif/networkdrive/webdavs/macos.rst @@ -0,0 +1,20 @@ +.. _sif-networkdrive-mdavs: + +Setup WebDAVS on MacOS +====================== + +.. _sif-networkdrive-mdavssetup: + +Setup WebDAVS via Finder +------------------------ + +On MacOS you can access remote WebDAVS content with the built-in file manager, Finder. +In the menu under **Go** you select **Connect to Server**. + + +Enter the server URL from the **WebDAVS** setup tab and click **Connect**. + +You will then be prompted for your automatic username and the password you entered. +The automated username will be *yourmail@projectName* and can be seen in the **Setup** tab. + +On success you will see the remote contents under the **SHARED** section of Finder. diff --git a/docs/sections/sif/networkdrive/webdavs/windows.rst b/docs/sections/sif/networkdrive/webdavs/windows.rst new file mode 100644 index 0000000..0808347 --- /dev/null +++ b/docs/sections/sif/networkdrive/webdavs/windows.rst @@ -0,0 +1,30 @@ +.. _sif-networkdrive-wdavs: + +Setup WebDAVS on Windows +======================== + +.. _sif-networkdrive-wdavssetup: + +Setup WebDAVS via Windows File Manager +-------------------------------------- + +In Windows it is possible to access WebDAVS services directly from the built-in file manager. With the **Map network drive** or the **Add a network location** button available navigating to the **Computer** location. +Please note that Windows 7 only provides the latter functionality inside the **Map network drive** wizard while Windows 8 and later exposes it as a dedicated button. + +First click **Map network drive** to launch the wizard. + +Select which drive letter you want to use (Z: in the example) and enter the SIF server URL from the **WebDAVS** setup tab and click **Finish** to actually connect. +In most cases the server URL `https://sif-io.erda.dk `_ is used. + +You will then be prompted for your automatic username and the password you entered on the **WebDAVS** setup tab. The automated username will be *yourmail@projectName*. + +Click OK to login and complete the wizard. Your SIF files and folders should appear up in the standard file manager mapped as the chosen drive letter. + +As long as you are online you can use the files there just like your local files. When you are done working on the data, you can right-click the mapped drive and select *Disconnect* to close the mapping. + +Netxt time you start your computer you can easily access the project data again using the saved mapped drive from the same **Computer** location. +Importantly you need to always log in first and provide your two-factor token on the SIF web page before you can access the mapped drive. + +It is also possible to make the remote content available as a so-called network location by filling in the server URL from above directly in the *Folder* field of the **Add network location** wizard. + +