Tutorial I

iterate-ch · Aug 16, 2024 · 3060346 · 3060346
1 parent 4b82d2f
commit 3060346
Show file tree

Hide file tree

Showing 22 changed files with 194 additions and 0 deletions.
diff --git a/index.md b/index.md
@@ -38,6 +38,13 @@ protocols/profiles/index
 cryptomator/index
 ```
 
+```{toctree}
+:hidden:
+:titlesonly:
+:caption: Tutorials & Workarounds
+tutorials/index
+```
+
 ## Support
 
 If you have a feature request or bug to report you can open a new ticket. The pages below has all the information on how to collect relevant log files.

diff --git a/tutorials/cyberduck/index.md b/tutorials/cyberduck/index.md
@@ -0,0 +1,12 @@
+Tutorials for Cyberduck
+===
+
+:::{toctree}
+:hidden:
+:titlesonly:
+
+
+
+:::
+
+Coming soon
diff --git a/tutorials/index.md b/tutorials/index.md
@@ -0,0 +1,24 @@
+Cyberduck & Mountain Duck Tutorials
+====
+
+:::{toctree}
+:hidden:
+:titlesonly:
+cyberduck/index
+mountainduck/index
+workarounds/index
+:::
+
+Find detailed step-by-step instructions for setup, connecting and most common use-cases as well as tutorials for more complicated workarounds.
+
+### [Cyberduck](cyberduck/index.md)
+
+Detailed instructions how to setup and use Cyberduck.
+
+### [Mountain Duck](mountainduck/index.md)
+
+Step-by-step instruction how to setup and use Mountain Duck
+
+### [Workarounds](workarounds/index.md)
+
+Instructions for specific workarounds as well as generall topics.
diff --git a/tutorials/mountainduck/index.md b/tutorials/mountainduck/index.md
@@ -0,0 +1,12 @@
+Tutorials for Mountain Duck
+===
+
+:::{toctree}
+:hidden:
+:titlesonly:
+
+
+
+:::
+
+Coming soon
diff --git a/tutorials/workarounds/_images/APIs_Services_Client_ID.png b/tutorials/workarounds/_images/APIs_Services_Client_ID.png
diff --git a/tutorials/workarounds/_images/App_Information_Client_ID.png b/tutorials/workarounds/_images/App_Information_Client_ID.png
diff --git a/tutorials/workarounds/_images/Application_Type_Client_ID.png b/tutorials/workarounds/_images/Application_Type_Client_ID.png
diff --git a/tutorials/workarounds/_images/Client_ID_Credentials.png b/tutorials/workarounds/_images/Client_ID_Credentials.png
diff --git a/tutorials/workarounds/_images/Consent_Screen_Client_ID.png b/tutorials/workarounds/_images/Consent_Screen_Client_ID.png
diff --git a/tutorials/workarounds/_images/Create_New_Project_Client_ID.png b/tutorials/workarounds/_images/Create_New_Project_Client_ID.png
diff --git a/tutorials/workarounds/_images/Edit_Custom_Client_ID_Profile.png b/tutorials/workarounds/_images/Edit_Custom_Client_ID_Profile.png
diff --git a/tutorials/workarounds/_images/Enable_APIs_Client_ID.png b/tutorials/workarounds/_images/Enable_APIs_Client_ID.png
diff --git a/tutorials/workarounds/_images/List_of_Scopes_Client_ID.png b/tutorials/workarounds/_images/List_of_Scopes_Client_ID.png
diff --git a/tutorials/workarounds/_images/OAuth_Client_ID_Credentials.png b/tutorials/workarounds/_images/OAuth_Client_ID_Credentials.png
diff --git a/tutorials/workarounds/_images/Search_Google_API.png b/tutorials/workarounds/_images/Search_Google_API.png
diff --git a/tutorials/workarounds/_images/Test_Users_Client_ID.png b/tutorials/workarounds/_images/Test_Users_Client_ID.png
diff --git a/tutorials/workarounds/_static/Ressources/ftp-default.reg b/tutorials/workarounds/_static/Ressources/ftp-default.reg
diff --git a/tutorials/workarounds/_static/css/custom.css b/tutorials/workarounds/_static/css/custom.css
@@ -0,0 +1,37 @@
+@import url("https://cdn.cyberduck.io/css/custom.css");
+
+body {
+    font-size: 16px;
+}
+
+.wy-nav-content {
+  max-width: 100%
+}
+
+.text-align\:left {
+  text-align: left;
+}
+.text-align\:center {
+  text-align: center;
+}
+.text-align\:right {
+  text-align: right;
+}
+
+.wy-menu-vertical a:hover, .wy-menu-vertical a:focus {
+  color: inherit;
+}
+
+.rst-content blockquote {
+  font-size: 16px;
+  margin: 0;
+}
+
+.rst-content blockquote p {
+  padding-left: 10px;
+  border-left: 5px solid #ccc;
+}
+
+.sphinx-tabs-panel {
+  padding: 1em 1em 0 1em;
+}
diff --git a/tutorials/workarounds/_static/favicon.ico b/tutorials/workarounds/_static/favicon.ico
diff --git a/tutorials/workarounds/_static/videos/mountainduck/keepoffline.mp4 b/tutorials/workarounds/_static/videos/mountainduck/keepoffline.mp4
diff --git a/tutorials/workarounds/custom_oauth_client_id.md b/tutorials/workarounds/custom_oauth_client_id.md
@@ -0,0 +1,96 @@
+Setup a Custom OAuth Client ID for Google Drive
+===
+
+## Register Client ID
+
+Log in to your Google account, go to [Google Cloud resource manager](https://console.cloud.google.com/cloud-resource-manager) and create a new project.
+
+:::{image} _images/Create_New_Project_Client_ID.png
+:alt: Create new Project
+:width: 600px
+:::
+
+You will be prompt to select a name of the project. Once the project is created navigate to _APIs &  Services_ and select _Enable APIs & services_.
+
+:::{image} _images/APIs_Services_Client_ID.png
+:alt: APIs and Services
+:width: 600px
+:::
+
+Select _Enable APIs & services_ and search for "Google Drive API" in the search box of the API library.
+
+:::{image} _images/Enable_APIs_Client_ID.png
+:alt: Enable APIs
+:width: 600px
+:::
+
+The results will show three with the Google Drive icon. Select te result called _Google Drive API_ and enable it. The other two are optional but not necessary.
+
+:::{image} _images/Search_Google_API.png
+:alt: API Library Google Drive
+:width: 600px
+:::
+
+Afterward, go to _OAuth consent screen_.
+
+:::{image} _images/Consent_Screen_Client_ID.png
+:alt: Consent Screen OAuth Client ID
+:width: 600px
+:::
+
+Choose _External_ and select _Create_. Fill in the required information by using your own gmail address and select _Save and Continue_.
+
+:::{image} _images/App_Information_Client_ID.png
+:alt: App Information OAuth Client ID
+:width: 600px
+:::
+
+Select _Add or Remove Scopes_ in the next step. Search for "Google Drive API" and enable the scope ".../auth/drive". The other scopes are optional but not necessary. Select _Update_ to confirm and _Save and Continue_ to move to the next step.
+
+:::{image} _images/App_Information_Client_ID.png
+:alt: List of Scopes OAuth Client ID
+:width: 600px
+:::
+
+Add the email addresses for your gmail accounts after selecting _Add Users_.
+
+:::{image} _images/Test_Users_Client_ID.png
+:alt: Test Users OAuth Client ID
+:width: 600px
+:::
+
+Confirm by selecting _Save and Continue_. Check the overview and choose _Back to Dashbord_ or go to _Credentials_ directly.
+
+:::{image} _images/Client_ID_Credentials.png
+:alt: OAuth Client ID Credentials
+:width: 600px
+:::
+
+Select _Desktop app_ as application type, name the credential, and select _Create_ to confirm.
+
+:::{image} _images/Application_Type_Client_ID.png
+:alt: Application Type for Credentials
+:width: 600px
+:::
+
+The Credentials will be created and displayed automatically. Make sure save the credentials in a save place as you need them to set up the custom connection profile in the next step.
+
+:::{image} _images/OAuth_Client_ID_Credentials.png
+:alt: OAuth Client ID Credentials
+:width: 400px
+:::
+
+## Add Custom Connection Profile
+
+Edit the sample profile and save it into the _Profiles_ folder of the application support folder.
+
+- {download}`Google Drive Custom OAuth Client ID.cyberduckprofile<_static/Google Drive Custom OAuth Client ID.cyberduckprofile>`
+
+Use the OAuth credentials to edit the following sections of the sample profile:
+
+:::{image} _images/Edit_Custom_Client_ID_Profile.png
+:alt: Edit Google OAuth Client ID
+:width: 600px
+:::
+
+The saved profile will be available in the _Protocol_ section of the bookmark configuration. 
diff --git a/tutorials/workarounds/index.md b/tutorials/workarounds/index.md
@@ -0,0 +1,6 @@
+Workarounds & General Instructions
+===
+
+The list of Workarounds will be updated based on new topics:
+
+- To fix the `This app is blocked` error by Google Drive, please check the instructions to set up a [Custom OAuth Client ID](custom_oauth_client_id.md)