Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/user/ios-app/general/settings/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Settings",
"position": 4,
"key": "ios-settings"
}
42 changes: 42 additions & 0 deletions docs/user/ios-app/general/settings/acknowledgements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
sidebar_position: 11
title: Acknowledgements
description: View the third-party libraries and acknowledgements used by the OpenCloud iOS app.
draft: false
---

# Acknowledgements

The **Acknowledgements** section lists the third-party libraries and open-source components used by the OpenCloud iOS app.

## Open the Acknowledgements

1. Open the **OpenCloud** app.
2. Tap **Settings**.
3. Under **More**, tap **Acknowledgements**.

<img src={require("../../img/settings/acknowledgements/acknowledgements button.png").default}
alt="Acknowledgements Button" height="650"/>

## Browse Third-Party Components

The **Acknowledgements** page displays a list of third-party libraries and frameworks that are used by the app.

Depending on the app version, the list may include components such as:

- PLCrashReporter
- Down
- PocketSVG
- OpenSSL
- ISRunLoopThread

Tap any entry to view additional information about the corresponding library.

<img src={require("../../img/settings/acknowledgements/acknowledgements menu.png").default}
alt="Acknowledgements Page" height="650"/>

:::note

The displayed libraries may change between OpenCloud releases as dependencies are added, updated, or removed.

:::
41 changes: 41 additions & 0 deletions docs/user/ios-app/general/settings/app-version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
sidebar_position: 12
title: App Version
description: View and copy the installed OpenCloud app version information.
draft: false
---

# App Version

The **App Version** section displays detailed version information about your installed OpenCloud app, including the application version, build number, and SDK version.

## Copy the App Version Information

1. Open the **OpenCloud** app.
2. Tap **Settings**.
3. Scroll to the bottom of the page.
4. Tap **App Version**.

<img src={require("../../img/settings/app-version/app version button.png").default}
alt="App Version Button" height="650"/>

## Version Information Copied

After tapping **App Version**, the complete version information is automatically copied to your device's clipboard.

A confirmation message appears at the top of the screen indicating that the version information has been copied successfully.

<img src={require("../../img/settings/app-version/copied app version pop up.png").default}
alt="App Version copied confirmation" height="650"/>

:::tip

If you need to report a bug or contact support, simply tap **App Version** before creating your report. You can then paste the copied version information directly into your support request.

:::

:::note

The copied information may include the application version, build number, release date, commit identifier, and SDK version, depending on your OpenCloud release.

:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
sidebar_position: 6
id: auto-upload-photos-and-videos
title: Auto Upload Photos and Videos
description: Auto upload photos and videos from your iPhone or iPad.
draft: false
---

# Auto Upload

Auto Upload automatically uploads newly created photos and videos from your iPhone or iPad to your OpenCloud account.

Once configured, new media is uploaded automatically whenever the OpenCloud app is opened and running in the foreground.

## Requirements

Before using Auto Upload, ensure that:

- You are signed in to your OpenCloud account.
- The OpenCloud app has permission to access your photo library.
- A destination folder has been configured for uploads.

## Configure Auto Upload

1. Open the **OpenCloud** app.
2. Tap **Settings**.

<img src={require("../../img/settings/auto-upload-photos-and-videos/settings-button.png").default} alt="Settings Button" height="650"/>

3. Scroll down to the **Media Files** section.
4. Tap **Media Upload**.

<img src={require("../../img/settings/auto-upload-photos-and-videos/media-upload-button.png").default} alt="Media Upload Button" height="650"/>

## Enable Auto Upload

Photos and videos can be enabled independently.

The following options are available:

- **Convert HEIC to JPEG** – Converts HEIC images to JPEG before uploading.
- **Convert videos to MP4** – Converts videos to MP4 before uploading.
- **Preserve original media file names** – Keeps the original filename instead of generating a new one.
- **Auto Upload Photos** – Automatically uploads newly created photos.
- **Auto Upload Videos** – Automatically uploads newly created videos.
- **Photo upload path** – Selects the destination folder for uploaded photos.

<img src={require("../../img/settings/auto-upload-photos-and-videos/auto-upload-photos.png").default} alt="Auto Upload settings" height="650"/>

## Select the Upload Destination

Before Auto Upload can begin, you must select the destination folder.

1. Tap **Photo upload path**.
2. Browse to the folder where photos should be uploaded.
3. Tap **Select Destination**.

<img src={require("../../img/settings/auto-upload-photos-and-videos/select-destination.png").default} alt="Selecting an upload destination" height="650"/>

## How Auto Upload Works

:::important Current iOS Behavior

At the moment, Auto Upload only detects and uploads newly created photos and videos while the OpenCloud app is running in the foreground.

If the app is closed or running in the background, new media is **not** uploaded until the app is opened again.

Simply opening the OpenCloud app starts the Auto Upload process. Any new media created since the last successful upload is detected automatically and uploaded.

:::

If the configured upload folder is deleted, Auto Upload stops automatically until a new destination folder is selected.

### Preventing Duplicate Uploads

To prevent duplicate uploads, Auto Upload stores the timestamp of the last successfully uploaded item.

When Auto Upload is enabled for the first time, the activation timestamp is stored and compared with the creation date of each photo and video. After a file has been uploaded successfully, its creation timestamp becomes the new reference point.

This approach provides several advantages:

- Prevents photos and videos from being uploaded more than once.
- Eliminates the need to maintain a local database of uploaded files.
- Previously uploaded media is not uploaded again, even if it is edited later.

### Media Conversion

If media conversion is enabled, Auto Upload automatically applies the selected conversion settings before uploading photos and videos.
52 changes: 52 additions & 0 deletions docs/user/ios-app/general/settings/cellular-data-usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
sidebar_position: 4
title: Cellular Data Usage
description: Configure which OpenCloud features are allowed to use your mobile data connection.
draft: false
---

# Cellular Data Usage

The **Cellular Data Usage** settings allow you to control whether OpenCloud is permitted to use your mobile data connection and which features are allowed to transfer data while you are not connected to Wi-Fi.

## Configure Cellular Data Usage

1. Open the **OpenCloud** app.
2. Tap **Settings**.
3. Select **Cellular Data Usage**.

The **Cellular Data Usage** page lets you configure how the app uses your mobile data connection.

<img src={require("../../img/settings/cellular-data-usage/cellular data usage.png").default} alt="Cellular Data Usage Button" height="650"/>

## General Settings

The following option is available under **General**:

- **Allow cellular access** – Enables or disables the use of mobile data for the entire OpenCloud app.

When this option is disabled, OpenCloud transfers data only while connected to Wi-Fi.

## Feature-specific Settings

You can independently control which features are allowed to use mobile data.

The following options are available:

- **Available Offline** – Allows files marked as available offline to be downloaded and synchronized using a mobile data connection.
- **Photo upload** – Allows Auto Upload to upload photos using mobile data.
- **Video upload** – Allows Auto Upload to upload videos using mobile data.

## How Cellular Data Usage Works

:::important

Disabling **Allow cellular access** overrides all feature-specific settings.

When this option is turned off, OpenCloud uses Wi-Fi connections only, regardless of the individual feature settings.

:::

Feature-specific settings only take effect when **Allow cellular access** is enabled.

This allows you to decide exactly which OpenCloud features may use your mobile data connection while preventing unnecessary data usage.
60 changes: 60 additions & 0 deletions docs/user/ios-app/general/settings/delete-unused-local-copies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
sidebar_position: 5
title: Delete Unused Local Copies
description: Automatically remove locally stored files after a configurable period to save storage space.
draft: false
---

# Delete Unused Local Copies

The **Delete unused local copies** setting automatically removes downloaded files from your device after a specified period of inactivity.

Only the local copies are removed. Your files remain safely stored in OpenCloud and can be downloaded again at any time when needed.

## Configure Delete Unused Local Copies

1. Open the **OpenCloud** app.
2. Tap **Settings**.
3. Under **Data usage**, tap **Delete unused local copies**.

The **Delete unused local copies** setting allows you to choose how long downloaded files should remain stored locally before they are automatically removed.

<img src={require("../../img/settings/delete-unused-local-copies/delete unused local copies button.png").default} alt="Delete unused local copies Button" height="650"/>

## Available Options

You can choose one of the following retention periods:

- **Never** – Local copies are never removed automatically.
- **After 1 day**
- **After 7 days**
- **After 30 days**

The selected period starts after the file was last accessed on your device.

Select the retention period that best matches your workflow.

Files that have not been accessed within the selected time are automatically removed from the device while remaining available in your OpenCloud account.

<img src={require("../../img/settings/delete-unused-local-copies/delete unused local copies settings.png").default} alt="Delete unused local copies settings" height="650"/>

## How It Works

Only files that are stored locally are affected.

The following data is **not deleted**:

- Files stored in OpenCloud
- Folder structure
- Shared files
- File metadata

When you open a removed file again, OpenCloud automatically downloads it from the server.

:::important

This feature only removes the **local copy** from your device.

Your files remain securely stored in OpenCloud and are available for download at any time.

:::
51 changes: 51 additions & 0 deletions docs/user/ios-app/general/settings/help-and-contact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
sidebar_position: 7
title: Help & Contact
description: Learn how to access the OpenCloud documentation, report issues, and get help from the community.
draft: false
---

# Help & Contact

The **Help & Contact** section provides quick access to OpenCloud resources, including the official documentation, the GitHub issue tracker, and the community discussions.

## Open Help & Contact

1. Open the **OpenCloud** app.
2. Tap **Settings**.
3. Scroll to the **More** section.
4. Tap **Help & Contact**.

The **Help & Contact** page gives you access to documentation and community support resources.

<img src={require("../../img/settings/help-and-contact/help and contact button.png").default}
alt="Help & Contact Button"
height="650"/>

## Available Resources

The **Help & Contact** page provides the following resources:

- **View documentation** – Opens the official OpenCloud documentation containing user guides, setup instructions, and feature descriptions.
- **File an issue** – Opens the GitHub issue tracker where you can report bugs or request new features.
- **Visit GitHub Discussions** – Opens the OpenCloud community discussions where you can ask questions, share ideas, and get help from other users.

Use these resources whenever you need additional information, want to report a problem, or interact with the OpenCloud community.

<img src={require("../../img/settings/help-and-contact/help and contact menu.png").default}
alt="Help & Contact Page"
height="650"/>

## When to Use Each Resource

| Resource | Recommended for |
| ---------------------- | --------------------------------------------------------------------- |
| **View documentation** | Learning how OpenCloud features work and finding step-by-step guides. |
| **File an issue** | Reporting bugs, unexpected behavior, or requesting new features. |
| **GitHub Discussions** | Asking questions, getting community support, and sharing ideas. |

:::tip

If you encounter a problem, it's a good idea to check the documentation first. If the issue persists, search the GitHub Discussions or create a GitHub issue if you've found a bug.

:::
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
---
sidebar_position: 4
id: settings
title: Settings
description: Setting in OpenCloud iOS app
draft: false
---

# Settings
Expand All @@ -16,7 +12,7 @@ In the iOS app settings changes can be made, such as
- Media files
and more

<img src={require(".././img/settings/settings.png").default} alt="Settings" width="1920"/>
<img src={require("../.././img/settings/settings.png").default} alt="Settings" width="1920"/>

## Userinterface

Expand Down
Loading