Skip to content
Merged
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
53 changes: 24 additions & 29 deletions docs/admin/maintenance/backup.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,46 @@
---
sidebar_position: 2
id: backup
title: 'Backup'
title: Backup
description: Backup
draft: false
---

## Regular backups are essential to ensure that your OpenCloud instance can be restored in case of issues
# Backup

---
Regular backups are essential to ensure that your OpenCloud instance can be restored in case of issues

## General considerations

### General considerations
### Storage Options

#### OpenCloud supports two different storage setups
OpenCloud supports two different storage setups:

- Pure POSIX Setup: All data (configuration, blobs, and metadata) is stored on a POSIX-compliant filesystem.

- Distributed Setup: Blobs are stored on an S3-compliant storage, while configuration and metadata remain on a POSIX-compliant filesystem

To determine which filesystems are supported, see: Filesystems and Shared Storage

---
## Backup strategies

### Backup strategies
### Consistent Backup Requirement

#### To create a consistent backup, the OpenCloud instance must be stopped before starting the backup process. After the backup is complete, the instance can be restarted
To create a consistent backup, the OpenCloud instance must be stopped before starting the backup process. After the backup is complete, the instance can be restarted

**There are two recommended approaches:**
There are two recommended approaches:

- Snapshot-based backup (recommended)
- If your storage system supports snapshots, creating a backup only takes a few seconds

- Snapshots should be copied to secondary storage or used by backup software for additional security

-Backup software approach

- If snapshots are not available, you can use any backup software of your choice

- For more details on data locations, refer to the Default Paths documentation

---
- Backup software approach

### Required backup components
- If snapshots are not available, you can use any backup software of your choice
- For more details on data locations, refer to the Default Paths documentation

#### A complete backup must include
## Required backup components

- Configuration data

Expand All @@ -61,11 +60,9 @@ To determine which filesystems are supported, see: Filesystems and Shared Storag

- This ensures compatibility when restoring and prevents issues caused by software version mismatches

---

### Pure POSIX setup
## Pure POSIX setup

#### If all data (configuration, blobs, and metadata) is stored on a POSIX-compliant filesystem
If all data (configuration, blobs, and metadata) is stored on a POSIX-compliant filesystem

- Stop the OpenCloud instance

Expand All @@ -77,11 +74,9 @@ To determine which filesystems are supported, see: Filesystems and Shared Storag

- Restart the OpenCloud instance after the backup is complete

---

### Distributed setup
## Distributed setup

#### If blobs are stored on S3, while configuration and metadata remain on a POSIX-compliant filesystem
If blobs are stored on S3, while configuration and metadata remain on a POSIX-compliant filesystem

- Stop the OpenCloud instance

Expand All @@ -91,6 +86,6 @@ To determine which filesystems are supported, see: Filesystems and Shared Storag

- Restart the OpenCloud instance after the backup is complete

---

#### With these backup strategies, you can ensure that your OpenCloud instance remains secure and restorable in case of issues
:::note
With these backup strategies, you can ensure that your OpenCloud instance remains secure and restorable in case of issues
:::
5 changes: 3 additions & 2 deletions docs/admin/maintenance/dataexport.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
sidebar_position: 5
id: dataexport
title: 'Data Export'
description: 'Information about data export.'
title: Data Export
description: Information about data export.
draft: false
---

# Data Export
Expand Down
71 changes: 29 additions & 42 deletions docs/admin/maintenance/migrate.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
---
sidebar_position: 3
id: migrate
title: 'Migrate'
description: 'Guide to migrating data using rclone.'
title: Migrate
description: Guide to migrating data using rclone.
draft: false
---

import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'

## 🚀 Migrate Personal Space Data to OpenCloud Using rclone
# Migrate

Migrate Personal Space Data to OpenCloud Using rclone

This guide will help you migrate personal space data from `NextCloud` and `oCIS` to `OpenCloud` using `rclone`. Follow these steps carefully to ensure a smooth migration!

### 1. Generate users token using CLI or API
## Generate users token using CLI or API

<Tabs>
<TabItem value="opencloud" label="OpenCloud">

### Run OpenCloud with the following configuration
## Run OpenCloud with the following configuration

Modify `.env` file:

Expand Down Expand Up @@ -45,9 +48,7 @@ Generate an authentication token for a user (e.g., `alan`) with expiration (`h`,
opencloud auth-app create --user-name=alan --expiration=72h
```

---

### Generate user token using API
## Generate user token using API

Requires additional configuration! Start the server with:

Expand Down Expand Up @@ -79,7 +80,7 @@ Enable `auth-app` service:
PROXY_ENABLE_APP_AUTH="true"
```

### Generate user token using CLI
## Generate user token using CLI

Access the oCIS container:

Expand All @@ -93,9 +94,7 @@ Generate an authentication token for a user (e.g., `einstein`) with expiration (
ocis auth-app create --user-name=einstein --expiration=72h
```

---

### Generate user token using API
## Generate user token using API

Requires additional configuration! Start the server with:

Expand All @@ -122,31 +121,25 @@ Create a new App Password
</TabItem>
</Tabs>

---

### 2. Install rclone

Download and install rclone by following the official guide: 🔗[**rclone.org/install**](https://rclone.org/install/)
## Install rclone

---
Download and install rclone by following the official guide: [rclone.org/install](https://rclone.org/install/)

### 3. Encrypt Authentication Tokens 🔒
## Encrypt Authentication Tokens

```bash
rclone obscure <token>
```

---

### 4. Create the rclone Configuration 🛠️
## Create the rclone Configuration

Edit the rclone configuration file:

```bash
nano ~/.config/rclone/rclone.conf
```

📌 Example Configuration:
- Example Configuration

```bash
[opencloud-admin]
Expand Down Expand Up @@ -205,9 +198,7 @@ description = nc-bob

```

---

### 5. Copy Data to OpenCloud
## Copy Data to OpenCloud

Use `rclone copy` to transfer data from `oCIS` and `Nextcloud` to `OpenCloud`:

Expand All @@ -218,25 +209,21 @@ rclone copy nc-bob:/ opencloud-alan:/ --no-check-certificate -P # Copy Nextclou

```

---

### 6. Migration Results and Limitations

🎉 Congratulations! You have successfully migrated personal space data to OpenCloud! 🚀

✅ Successfully Migrated:
## Migration Results and Limitations

- Personal space files
Congratulations! You have successfully migrated personal space data to OpenCloud!

❌ Not Migrated:
- Successfully Migrated
- Personal space files

- Shared files
- Public links
- Project spaces
- Trash-bin contents
- File versions
- Metadata
- Not Migrated
- Shared files
- Public links
- Project spaces
- Trash-bin contents
- File versions
- Metadata

### 7. Security Step: Delete Tokens
## Security Step: Delete Tokens

Once the migration is complete, please delete tokens to prevent unauthorized access!
19 changes: 10 additions & 9 deletions docs/admin/maintenance/uninstall.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
---
sidebar_position: 4
id: uninstall
title: 'Uninstall'
description: 'Guide to uninstall OpenCloud.'
title: Uninstall
description: Guide to uninstall OpenCloud.
draft: false
---

# Uninstall OpenCloud with Docker Compose

> ⚠️ **Warning:** This guide will completely remove all OpenCloud data. Make sure to back up any important files before proceeding.
:::warning
This guide will completely remove all OpenCloud data. Make sure to back up any important files before proceeding.
:::

---

## Step 1: Stop and Remove Docker Containers
## Stop and Remove Docker Containers

Navigate to your `opencloud-compose` directory (where your `docker-compose.yml` file is located), then run:

Expand All @@ -25,7 +26,7 @@ To also remove unnamed volumes and orphan containers:
docker compose down --volumes --remove-orphans
```

## Step 2: Remove Docker Volumes
## Remove Docker Volumes

To check your existing volumes:

Expand All @@ -51,7 +52,7 @@ Or to clean up all unused volumes (be careful!):
docker volume prune
```

## Step 3: Delete Mounted Directories (if used)
## Delete Mounted Directories (if used)

If your .env referenced local folders such as /mnt/opencloud/data, you should delete those manually:

Expand All @@ -62,7 +63,7 @@ sudo rm -rf /mnt/opencloud/config

Adjust the paths to match your setup.

## Step 4: Remove the Compose Project Folder (Optional)
## Remove the Compose Project Folder (Optional)

If you want to delete the entire project directory:

Expand Down
15 changes: 7 additions & 8 deletions docs/admin/maintenance/upgrade/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,24 @@
---
sidebar_position: 3
id: release-notes
title: 'Release Notes'
title: Release Notes
description: Release Notes
draft: false
---

# 📦 Release Notes: Migration from v2.x.x to v3.0.0
# Release Notes: Migration from v2.x.x to v3.0.0

- Version: 3.0.0
- Type: Major Release (Breaking Changes in the GraphAPI)
- [Details · Download](https://github.com/opencloud-eu/opencloud/releases/tag/v3.0.0)

---

## Who Is Affected?

This release introduces a **breaking change in the GraphAPI**.
If you are using OpenCloud only through official clients (Web, Desktop, or Mobile), **no migration is needed**.
This release introduces a breaking change in the GraphAPI.
If you are using OpenCloud only through official clients (Web, Desktop, or Mobile), no migration is needed.

If you're using any other software that utilizes the GraphAPI, that software might need to be adjusted to follow the new behavior of the GraphAPI.

---

## Key Changes

The following endpoints of the GraphAPI were changed in a way that is not backwards compatible with the previous releases:
Expand All @@ -33,4 +30,6 @@ GET /v1beta1/drives/
GET /v1beta1/me/drives/
```

:::note
Due to performance optimizations, these endpoints no longer automatically expand all permissions on the drives root items. If needed, the permissions can be explicitly requested via the appropriate $expand query option.
:::
Loading