Skip to content

Commit

Permalink
Device guides for Nextcloud service
Browse files Browse the repository at this point in the history
  • Loading branch information
stupleb committed Jul 26, 2024
1 parent 7d1ac7b commit 2585432
Show file tree
Hide file tree
Showing 99 changed files with 558 additions and 0 deletions.
22 changes: 22 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,28 @@ Welcome to the Start9 Docs! Here you will find everything you need to set up and
- [Connecting to LND](service-guides/lightning/lnd/)
- [Using LNbits](service-guides/lightning/lnbits.md)
- [Matrix](service-guides/matrix/)
- [Nextcloud](service-guides/nextcloud/)
- [Device Setup](service-guides/nextcloud/nextcloud-setup/)
- [Linux](service-guides/nextcloud/nextcloud-setup/nextcloud-linux.md)
- [MacOS](service-guides/nextcloud/nextcloud-setup/nextcloud-macos.md)
- [Windows](service-guides/nextcloud/nextcloud-setup/nextcloud-windows.md)
- [Android](service-guides/nextcloud/nextcloud-setup/nextcloud-android.md)
- [iOS](service-guides/nextcloud/nextcloud-setup/nextcloud-ios.md)
- [Apps & Integrations](service-guides/nextcloud/nextcloud-apps/)
- [Nextcloud Bookmarks](service-guides/nextcloud/nextcloud-apps/nextcloud-bookmarks.md)
- [Nextcloud Calendar](service-guides/nextcloud/nextcloud-apps/nextcloud-calendar.md)
- [Nextcloud Contacts](service-guides/nextcloud/nextcloud-apps/nextcloud-contacts.md)
- [Nextcloud Cookbook](service-guides/nextcloud/nextcloud-apps/nextcloud-cookbook.md)
- [Nextcloud Files](service-guides/nextcloud/nextcloud-apps/nextcloud-files.md)
- [Nextcloud Maps](service-guides/nextcloud/nextcloud-apps/nextcloud-maps.md)
- [Nextcloud Memories](service-guides/nextcloud/nextcloud-apps/nextcloud-memories.md)
- [Nextcloud Music](service-guides/nextcloud/nextcloud-apps/nextcloud-music.md)
- [Nextcloud News](service-guides/nextcloud/nextcloud-apps/nextcloud-news.md)
- [Nextcloud Notes](service-guides/nextcloud/nextcloud-apps/nextcloud-notes.md)
- [Nextcloud Photos](service-guides/nextcloud/nextcloud-apps/nextcloud-photos.md)
- [Joplin](service-guides/nextcloud/nextcloud-apps/nextcloud-photos.md)
- [Thunderbird](service-guides/nextcloud/nextcloud-apps/nextcloud-photos.md)


### Misc Guides

Expand Down
21 changes: 21 additions & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,27 @@
- [BlueWallet](service-guides/lightning/lnbits/bluewallet.md)
- [Zeus](service-guides/lightning/lnbits/zeus.md)
- [Matrix](service-guides/matrix/README.md)
- [Nextcloud](service-guides/nextcloud/README.md)
- [Device Setup](service-guides/nextcloud/nextcloud-setup/README.md)
- [Linux](service-guides/nextcloud/nextcloud-setup/nextcloud-linux.md)
- [MacOS](service-guides/nextcloud/nextcloud-setup/nextcloud-macos.md)
- [Windows](service-guides/nextcloud/nextcloud-setup/nextcloud-windows.md)
- [Android](service-guides/nextcloud/nextcloud-setup/nextcloud-android.md)
- [iOS](service-guides/nextcloud/nextcloud-setup/nextcloud-ios.md)
- [Apps & Integrations](service-guides/nextcloud/nextcloud-apps/README.md)
- [Nextcloud Bookmarks](service-guides/nextcloud/nextcloud-apps/nextcloud-bookmarks.md)
- [Nextcloud Calendar](service-guides/nextcloud/nextcloud-apps/nextcloud-calendar.md)
- [Nextcloud Contacts](service-guides/nextcloud/nextcloud-apps/nextcloud-contacts.md)
- [Nextcloud Cookbook](service-guides/nextcloud/nextcloud-apps/nextcloud-cookbook.md)
- [Nextcloud Files](service-guides/nextcloud/nextcloud-apps/nextcloud-files.md)
- [Nextcloud Maps](service-guides/nextcloud/nextcloud-apps/nextcloud-maps.md)
- [Nextcloud Memories](service-guides/nextcloud/nextcloud-apps/nextcloud-memories.md)
- [Nextcloud Music](service-guides/nextcloud/nextcloud-apps/nextcloud-music.md)
- [Nextcloud News](service-guides/nextcloud/nextcloud-apps/nextcloud-news.md)
- [Nextcloud Notes](service-guides/nextcloud/nextcloud-apps/nextcloud-notes.md)
- [Nextcloud Photos](service-guides/nextcloud/nextcloud-apps/nextcloud-photos.md)
- [Joplin](service-guides/nextcloud/nextcloud-apps/nextcloud-photos.md)
- [Thunderbird](service-guides/nextcloud/nextcloud-apps/nextcloud-photos.md)

# Misc Guides

Expand Down
6 changes: 6 additions & 0 deletions src/service-guides/nextcloud/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Nextcloud

These guides will help you to setup tools to connect or interact with Nextcloud.

- [Nexcloud Device Setup](./nextcloud-setup/) - Set up your client device to connect to Nextcloud
- [Nextcloud Apps & Integrations](./nextcloud-apps/) - Setup and use Nextcloud and 3rd party apps
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions src/service-guides/nextcloud/nextcloud-apps/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Nextcloud Apps & Integrations
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Nextcloud Bookmarks
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Nextcloud Calendar
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Nextcloud Contacts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Nextcloud Cookbook
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Nextcloud Files
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Nextcloud Maps
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Nextcloud Memories
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Nextcloud Music
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Nextcloud News
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Nextcloud Notes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Thunderbird
9 changes: 9 additions & 0 deletions src/service-guides/nextcloud/nextcloud-setup/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Nextcloud Device Setup

Connection guides by Device. This will guide you through initial setup and syncing configurations.

- [Linux](nextcloud-linux.md)
- [MacOS](nextcloud-macos.md)
- [Windows](nextcloud-windows.md)
- [Android](nextcloud-android.md)
- [iOS](nextcloud-ios.md)
137 changes: 137 additions & 0 deletions src/service-guides/nextcloud/nextcloud-setup/nextcloud-android.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
# Nextcloud - Android

## Initial Config

It is advised to setup your Nextcloud devices on LAN (if available) for the best experience. Once set up, Tor can be used for remote syncing, but remember that large files will likely fail or take a very long time, so it is best to use remote sync only for low-bandwidth activity, such as Calendar, Contacts, Tasks, and Notes. Streaming your music is also possible. Later in 2023, new connection options will unlock Nextcloud's full feature-set.

## Nextcloud App

The latest version of the official Nextcloud client is available on their [download page](https://nextcloud.com/install/#install-clients). This is for file syncing and account management.


## LAN Setup

Make sure you have first set up [LAN access](/device-guides/android/ca.md).

1. Open Nextcloud via your server's Services -> Nextcloud -> Launch UI

1. Log in and select the top right icon -> Personal Settings:

![Nextcloud: > Personal Settings](../assets/web-step1-personal_settings.png)


1. Select the hamburger (3 lines) menu:

![Nextcloud: Personal Settings > Hamburger menu](../assets/web-step2-ps-profile.png)


1. Select Security:

![Nextcloud: Personal Settings > Security](../assets/web-step3-security.png)


1. Under `Devices & sessions`, give this Nextcloud mobile app a session name, such as "Mobile" and tap `Create new app password`:

![Nextcloud: Devices & sessions > Create new app password](../assets/web-step4-new_session.png)


1. Tap `Show QR code for mobile apps`:

![Nextcloud Show new session's QR code](../assets/web-step5-show_qr_code.png)


1. The new session's QR code will be displayed:

![Nextcloud: New session's QR code is shown](../assets/web-step6-qr_code_shown.png)

1. Download and install the appropriate desktop client for your Android device from https://nextcloud.com/install/#install-clients

1. Open the Nextcloud client on your Android device and tap "Log in"

![Nextcloud mobile app Log in](../assets/step1-login.png)


1. Tap the QR code icon:

![Nextcloud mobile app QR Code button](../assets/step2-read_qrcode.png)


1. Scan the QR code presented in Step 7.


```admonish note
Here you may see an error about the Nextcloud app being unable to find the host that was decoded from the QR code:
![Nextcloud mobile app error Could not find host](../assets/pitfall1-could_not_connect_to_host-wifi-mdns-orbot.png)
If you see this message, you may be on an Android version that does not support mDNS .local name resolution (it is available on Android 13+ and some builds of Android 12, but not all. The other possibility is that your WiFi network is not properly "bridged" with the ethernet network that your Start9 server is on, or you lack WiFi connectivity to your network in general.
```



```admonish note
Alternatively, you may see a warning about an untrusted certificate:
![Nextcloud mobile app QR Code button](../assets/pitfall2-untrusted_cert.png)
In this case, make sure you have [added your server's CA certificate to the Android trust store](/device-guides/android/ca.md) as noted at the top of the `LAN Setup` section of this guide, close the Nextcloud mobile app and try again. Otherwise, proceed to the next step.
```

1. Android may ask you about Storage permissions. Grant "Full access":

![Nextcloud Storage permissions](../assets/step3-grant_file_access.png)

1. Next, configure the local directory that you want to sync with Nextcloud. You may use the default or change it, and edit the sync settings to desired. When satisfied, tap "Connect"

1. Files will begin to sync immediately and you will see a green check when this is complete.

1. That's it! From this desktop client you will recieve notifications, control accounts and syncing, and quickly access your Apps' WebUI pages


## Tor Setup

You will first need to have [Orbot running](/src/device-guides/android/tor.md).

1. First, add Nextcloud to your Orbot apps list.
2. Tap the account in the top-right, then "Add Account."
3. On the following screen, tap "Log in," then enter your Nextcloud Tor server address, which you can copy from Nextcloud -> Interfaces - Tor. This should start with ``https://`` and end with ``.onion``. tap Next.
4. This will launch your browser and prompt you to log in to your account. Log in and then grant access as we did for LAN.
5. That's it! You may wish to set up some select folders for remote sync, but for large files, it is best to sync on LAN only, so you can "Skip folders configuration" on the resulting screen if you wish. Check your connection by tapping into the newly created account in the app.


### Device Integration

In order to sync calendars and contacts with your Android device, follow the steps below, which are adapted from the [Official Nextcloud guide](https://docs.nextcloud.com/server/25/user_manual/en/groupware/sync_android.html). First head into the top-righthand menu of your Nextcloud's WebUI and click "Apps," then search for and install the Calendar and/or Contacts Apps.

1. Download the WebDAV sync management client [DAVx5](https://www.davx5.com/download/) from your app store of choice, such as F-Droid or the Play Store.

2. Add account:

- If you are on Android 12+ and already have the Nextcloud file-syncing app (recommended - guide above), then open it and enter the "Settings" menu from the top-lefthand hamburger (3 lines) menu. Then under the section titled, "More," tap "Sync Calendar & Contacts."

- This will open Nextcloud's WebFlow login in a browser, where you will need to log in and "Grant Access" - you will then be returned to DAVx5

- Set an account name when asked, then set "Contact Group Method" to "Groups are per-contact categories" - DAVx5 will close and Nextcloud will reappear.

- Manually launch DAVx5 again and top on the account that was just created. Grant access to Calendars and Contacts when requested, and optionally tasks, if you added that feature in setup. Choose the address books and calendars you wish to sync and you're done!

- If you are NOT using the Nextcloud app already, then open DAVx5 and after going through the introduction (optionally selecting additional features), tap the "+" icon to add a new account, then select "Login with URL and user name," and fill in the following fields:

- Base URL - Enter your Nextcloud WebDAV Base LAN URL (found in "Properties" in the Nextcloud service page).

- User name - Your Nextcloud user (defaults are found in "Properties" on your Nextcloud service page)

- Password - Your Nextcloud user's password (defaults are found in "Properties" on your Nextcloud service page)

- If given the option, select "Groups are per-contact categories," then tap "Login." Select the data you want to sync, grant access for contacts, calendars, and optionally tasks if you added that feature in setup. That's it, you're done!

```admonish tip
You may also wish to add the [ICSx5](https://icsx5.bitfire.at/) app, which allows subscription to remote WebCal or local iCal files (such as public event schedules, iCloud/Google calendars, etc). It can be found in your favorite app store.
```
105 changes: 105 additions & 0 deletions src/service-guides/nextcloud/nextcloud-setup/nextcloud-ios.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
# Nextcloud - iOS


## Initial Config

It is advised to setup your Nextcloud devices on LAN (if available) for the best experience. Once set up, Tor can be used for remote syncing, but remember that large files will likely fail or take a very long time, so it is best to use remote sync only for low-bandwidth activity, such as Calendar, Contacts, Tasks, and Notes. Streaming your music is also possible. Later in 2023, new connection options will unlock Nextcloud's full feature-set.


## Standalone Client

The latest version of the official Nextcloud client is available on their [download page](https://nextcloud.com/install/#install-clients).


## LAN Setup

Make sure you have first set up [LAN access](/device-guides/ios/ca.md).

1. Download the iOS Nextcloud client from [App Store](https://apps.apple.com/app/nextcloud/id1125420102).
1. Open the client and tap "Log In".

![nextcloud-ios-login](../assets/nextcloud-iOS-step2.png)


1. From your server's Nextcloud Service page, go to "Interfaces" and copy the LAN address.

![nextcloud-ios-login](../assets/nextcloud-mac-step3-lan.png)


1. Enter your LAN address under "Server Address" and tap "Next".

![nextcloud-ios-login](../assets/nextcloud-iOS-step4.png)


1. You will be shown the "Connect to your account" screen, and then click "Log In" and "Grant Access".

![nextcloud-ios-login](../assets/nextcloud-iOS-step5.png)

![nextcloud-ios-login](../assets/nextcloud-mac-step3-lan.png)


1. Next, you will be asked to enter the username and password, which can be found on the startOS Nextcloud Service page under the "Properties" tab.
![nextcloud-ios-login](../assets/nextcloud-iOS-step5.png)


1. The account access page will be displayed, tap "Grant access".

![nextcloud-ios-login](../assets/nextcloud-iOS-step6.png)


1. Files will begin syncing immediately, and you will see your username and account icon in the top left corner.

![nextcloud-ios-login](../assets/nextcloud-iOS-step7.png)


1. That's it! From this mobile client you can receive notifications, control accounts and syncing, and quickly access your apps' WebUI pages.


## Tor Setup

You will first need to have the [Tor daemon running](/device-guides/ios/tor.md).

1. Click the account in the top left again, then "Add Account."
2. On the following screen, click "Log in," then enter your Nextcloud Tor server address, which you can copy from Nextcloud -> Interfaces - Tor. This should start with ``https://`` and end with ``.onion``. Click Next.
3. This will launch your browser and prompt you to log in to your account. Log in and then grant access as we did for LAN.
4. That's it! You may wish to set up some select folders for remote sync, but for large files, it is best to sync on LAN only, so you can "Skip folders configuration" on the resulting screen if you wish. Check your connection by clicking the newly created account in the client app.

## Device Integration

In order to sync calendars and contacts with your iOS device, follow the steps below, which are adapted from the [Official Nextcloud guide](https://docs.nextcloud.com/server/25/user_manual/en/groupware/sync_ios.html).

First head into the top-righthand menu of your Nextcloud's WebUI and click "Apps," then search for and install the Calendar and/or Contacts Apps. Next folow guide for iOS.

![nextcloud account settings](../assets/nextcloud-iOS-native.png)


1. Open the "Settings" app on iOS device.

```admonish note
You will need to perform 2 individual setups, one for Calendar and one for Contacts.
```
1. Select "Calendar" (or "Contacts") -> "Accounts" -> "Add Account" -> "Other" -> "either CalDAV (for Calendar setup) or CardDAV (for Contacts setup)". Return to this step after completing one in order to add the other.
![nextcloud account settings](../assets/nextcloud-iOS-native-step1.png)
1. Enter the following fields and tap "Next":
- Server - Copy your URL from Nextcloud -> Calendar settings -> Copy iOS/macOS CalDav address. For setting up contacts/CardDav use the same path.
- User name - The default user is "embassy" but this is your user within Nextcloud, so be sure it is the correct user if you have more than one.
- Password - In your Nextcloud WebUI, visit the top-right-hand menu and select “Personal Settings” -> “Security.” At the bottom, under Devices & Sessions, create a new app password with a name of your choice, such as “iOSCalDAV.” Then, copy the resulting password into your iOS CalDAV account configuration.
- Description - Anything to describe this account, such as "Nextcloud CalDAV".
![nextcloud account settings](../assets/nextcloud-iOS-native-step2.png)
1. If you get a warning about verifying the server identity, it is safe to "Continue." Add the apps you want to use, such as Calendars, Contacts, and/or Reminders, then tap "Next".
- That's it! Go back to step 2 above to set up your other account (CalDAV / CardDAV).
Loading

0 comments on commit 2585432

Please sign in to comment.