diff --git a/content/docs/fast-track/fast-track.mdx b/content/docs/fast-track/fast-track.mdx new file mode 100644 index 00000000..257d3cf3 --- /dev/null +++ b/content/docs/fast-track/fast-track.mdx @@ -0,0 +1,150 @@ +--- +title: Fast Setup Guide +--- + +--- + +Use this page to quickly **choose a service** from a set of **basic** services we offer and **set it up** so that it works for you in a couple of minutes. This fast process requires an **average experienced** computer user. + +# Choose a service + +```mermaid +flowchart TB +%% A{("`Start`") + A("`I need a storage space to store data`") +%% B{"`I need a storage space to store data`"} +%% C["`Think again`"] + D{"`I need a long-term storage to store/publish **results of my research**, create an annotated dataset, link it to my **publication**, etc.`"} + M{"`My data is ...`"} + E(("`Use *National Repository Platform*`")) + F{"`I am an expert, developer, application maintainer, I have special or low-level requirements, or I need a significatly large storage space (more than 2 TB)...`"} +%% G{"`I need your help or assistance`"} +%% H{"`I have studied *S3 use cases* and/or *RBD use cases* and I know what I need`"} +%% I{"`I have special needs that are worth spending time on solving various technical difficulties`"} + J(("`Please *Contact us*
Specify your setup, ideas, requirements`")) +%% K(("`*Great!* Just go ahead!`")) +%% L["`Let's try easy options firts, it may save you a lot of time`"] + N{"`I need to have the data available offline and online, automatically synchronized between the storage and my computer`"} +%% O{"`I may need to share some of the data with a couple of colleagues here or there`"} + P{"`Data will be accessed (stored, read, modified) by ...`"} + Q(("`Use OwnCloud`")) +%% R(("`Well...`")) + S(("`Use *personal S3 storage* service`")) + T(("`Use *multiuser S3 storage* service (Virtual Organization)
Please contact us first.`")) + + click E "https://docs.nrp.eosc.cz/" "NRP" +%% click G "../introduction/support" "Support Page" +%% click H "../object-storage-s3/s3-use-cases" "S4 Use Cases" + click J "../introduction/support" "Support Page" + click Q "../fast-track#owncloud" "Fast-track Instructions Owncloud" +%% click R "https://www.storelocal.com/blogs/the-philosophy-of-storing-10-storage-features-to-enlighten-your-load/" "To Be Or Not To Be" + click S "../fast-track#personal-s3" "Fast-track Instructions S3 Personal" + click T "../introduction/support" "Support Page" + +%% A --> B + A --> F + F -->|yes| J + F -->|no| D +%% B -->|no| C +%% C --> B +%% B -->|yes| D + D -->|yes| E + D -->|no| M + M -->|"daily operational data (documents, graphics, tables, processed experimental data, ... of up to ~100 GB)"| Q + M -->|raw research data, archives, backups, device or instrumentations outputs of up to ~2 TB| P + M -->|hard to say| N +%% N -->|I do not care| O + N -->|yes| Q + N -->|no| P +%% O -->|perhaps| Q +%% O -->|I do not know| R + P -->|mostly me and/or my devices| S + P -->|"`a group of people (possibly accross institutions)
or instruments or devices`"| T +``` + +# Install and Configure + +## OwnCloud + +### Quick setup + +* To register and/or log in click on `Log in` button [here](https://owncloud.cesnet.cz/) and follow the instructions. Once logged-in, use drag-and-drop to upload files, click to download. + +If it does not work: [read full documentation](https://du.cesnet.cz/en/navody/owncloud/start), [contact support](https://docs.du.cesnet.cz/en/docs/introduction/support). + +> #### Where to go from here +> +> * To **sync** the cloud data storage space to your local drive, download and install [OwnCloud client](https://owncloud.com/desktop-app), run it and configure it using https://ownloud.cesnet.cz as the server address. +> * To **share** a folder with a colleague, click on the share symbol and enter your colleaugue's e-mail address (you need to enter whole address as there is [intentionally] no autocomplete). + +## Personal S3 + +### Windows Quick setup + +* Register in [Perun](https://einfra.cesnet.cz/), wait for 30 minutes to allow database synchrozation. +* Register in [Gatekeeper](https://access.du.cesnet.cz/) and generate a pair of keys, record the endpoint address and both keys. +* Install [S3 Browser](https://s3browser.com/). +* Add a new account to S3 Browser (*Accounts* / *Add new account..*); select `S3 Compatible Storage` as *Account type* and enter the credentials recorded before: `endpoint address` as *API endpoint*, `access-key` as *Access Key ID*, and `secret-key` as *Secret Access Key*. +* Use **S3 Browser** to copy files there and back. + +If it does not work: [read full documentation](../object-storage-s3/s3-service), [contact support](https://docs.du.cesnet.cz/en/docs/introduction/support). + +> #### Where to go from here: +> +> - understand more about the [S3 service](../object-storage-s3/s3-service) +> - check [different ways](../object-storage-s3/s3-clients) to access your storage +> - get [more information](https://s3browser.com/help.aspx) about using **S3 Browser** +> - setup and use [versioning support](https://s3browser.com/amazon-s3-versioning.aspx) in **S3 Browser** +> - install and configure [rclone](object-storage-s3/rclone) command line tool to +> - [synchronize files](../object-storage-s3/rclone#rclone-basic-controls) between the local drive and the storage +> - create automation scripts +> - configure and use [encrypted storage](../object-storage-s3/rclone#configuration-and-management-of-encrypted-buckets) +> - [mount](../object-storage-s3/rclone#mounting-the-remote-as-a-filesystem-or-a-drive) S3 storage as disk +> - ask for [help or support](../introduction/support) + +### MAC quick setup + +* Register in [Perun](https://einfra.cesnet.cz/), wait for 30 minutes to allow database synchrozation. +* Register in [Gatekeeper](https://access.du.cesnet.cz/) and generate a pair of keys, record the endpoint address and both keys. +* Install [Cyber Duck](https://cyberduck.io/). +* Open connection (*File* / *Open Connection*); select `Amazon S3` and enter the credentials recorded before: `endpoint address` as *Server*, `access-key` as *Access Key ID*, and `secret-key` as *Secret Access Key*. +* Select *Bookmark* / *New Bookmark* to store the configuration for the future use +* Use **Cyber Duck** to copy files there and back. + +If it does not work: [read full documentation](../object-storage-s3/s3-service), [contact support](https://docs.du.cesnet.cz/en/docs/introduction/support). + +> #### Where to go from here: +> +> - understand more about the [S3 service](../object-storage-s3/s3-service) +> - check [different ways](../object-storage-s3/s3-clients) to access your storage +> - get [more information](https://docs.cyberduck.io/) or [ask community for help](https://github.com/iterate-ch/cyberduck/discussions) about using **Cyber Duck** +> - install and configure [rclone](object-storage-s3/rclone) command line tool to +> - [synchronize files](../object-storage-s3/rclone#rclone-basic-controls) between the local drive and the storage +> - create automation scripts +> - configure and use [encrypted storage](../object-storage-s3/rclone#configuration-and-management-of-encrypted-buckets) +> - [mount](../object-storage-s3/rclone#mounting-the-remote-as-a-filesystem-or-a-drive) S3 storage as disk +> - ask for [help or support](../introduction/support) + +### Linux quick setup + +* Register in [Perun](https://einfra.cesnet.cz/), wait for 30 minutes to allow database synchrozation. +* Register in [Gatekeeper](https://access.du.cesnet.cz/) and generate a pair of keys, record the endpoint address and both keys. +* [Download](https://rclone.org/downloads/) and install **rclone**. +* [Configure](../object-storage-s3/rclone) **rclone** by calling ```rclone config```; use credentials recorded before. +* Use ```rclone sync``` to synchronize files to or from the storage (see [here](../object-storage-s3/rclone) or run ```rclone help``` or ```man rclone``` for more info). + +If it does not work: [read full documentation](../object-storage-s3/s3-service), [contact support](https://docs.du.cesnet.cz/en/docs/introduction/support). + +> #### Where to go from here: +> +> - understand more about the [S3 service](../object-storage-s3/s3-service) +> - check [different ways](../object-storage-s3/s3-clients) to access your storage +> - get [more information]https://rclone.org/) about using **rclone** +> - use [rclone](object-storage-s3/rclone) to +> - [synchronize files](../object-storage-s3/rclone#rclone-basic-controls) between the local drive and the storage +> - create automation scripts +> - configure and use [encrypted storage](../object-storage-s3/rclone#configuration-and-management-of-encrypted-buckets) +> - [mount](../object-storage-s3/rclone#mounting-the-remote-as-a-filesystem-or-a-drive) S3 storage as disk +> - ask for [help or support](../introduction/support) + + diff --git a/content/docs/fast-track/meta.json b/content/docs/fast-track/meta.json new file mode 100644 index 00000000..158ed6f6 --- /dev/null +++ b/content/docs/fast-track/meta.json @@ -0,0 +1,5 @@ + +{ + "title": "Fast Setup Guide", + "pages": [fast-track] +} diff --git a/content/docs/meta.json b/content/docs/meta.json index d9ceae3c..6e30a3fb 100644 --- a/content/docs/meta.json +++ b/content/docs/meta.json @@ -1,6 +1,7 @@ { "pages": [ "introduction", +"fast-track", "object-storage-s3", "object-storage-rbd", "collaboration",