Skip to content

Commit df2db49

Browse files
Heiko-PohlSvanvith
andauthored
rework admin maintenance docs (#399)
* reworking amin maintenance docs * adjust backup --------- Co-authored-by: Anja Barz <a.barz@opencloud.eu>
1 parent d2e8b34 commit df2db49

6 files changed

Lines changed: 84 additions & 108 deletions

File tree

docs/admin/maintenance/backup.md

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,46 @@
11
---
22
sidebar_position: 2
33
id: backup
4-
title: 'Backup'
4+
title: Backup
5+
description: Backup
6+
draft: false
57
---
68

7-
## Regular backups are essential to ensure that your OpenCloud instance can be restored in case of issues
9+
# Backup
810

9-
---
11+
Regular backups are essential to ensure that your OpenCloud instance can be restored in case of issues
12+
13+
## General considerations
1014

11-
### General considerations
15+
### Storage Options
1216

13-
#### OpenCloud supports two different storage setups
17+
OpenCloud supports two different storage setups:
1418

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

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

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

21-
---
25+
## Backup strategies
2226

23-
### Backup strategies
27+
### Consistent Backup Requirement
2428

25-
#### 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
29+
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
2630

27-
**There are two recommended approaches:**
31+
There are two recommended approaches:
2832

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

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

34-
-Backup software approach
35-
36-
- If snapshots are not available, you can use any backup software of your choice
37-
38-
- For more details on data locations, refer to the Default Paths documentation
39-
40-
---
38+
- Backup software approach
4139

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

44-
#### A complete backup must include
43+
## Required backup components
4544

4645
- Configuration data
4746

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

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

64-
---
65-
66-
### Pure POSIX setup
63+
## Pure POSIX setup
6764

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

7067
- Stop the OpenCloud instance
7168

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

7875
- Restart the OpenCloud instance after the backup is complete
7976

80-
---
81-
82-
### Distributed setup
77+
## Distributed setup
8378

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

8681
- Stop the OpenCloud instance
8782

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

9287
- Restart the OpenCloud instance after the backup is complete
9388

94-
---
95-
96-
#### With these backup strategies, you can ensure that your OpenCloud instance remains secure and restorable in case of issues
89+
:::note
90+
With these backup strategies, you can ensure that your OpenCloud instance remains secure and restorable in case of issues
91+
:::

docs/admin/maintenance/dataexport.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
22
sidebar_position: 5
33
id: dataexport
4-
title: 'Data Export'
5-
description: 'Information about data export.'
4+
title: Data Export
5+
description: Information about data export.
6+
draft: false
67
---
78

89
# Data Export

docs/admin/maintenance/migrate.md

Lines changed: 29 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
11
---
22
sidebar_position: 3
33
id: migrate
4-
title: 'Migrate'
5-
description: 'Guide to migrating data using rclone.'
4+
title: Migrate
5+
description: Guide to migrating data using rclone.
6+
draft: false
67
---
78

89
import Tabs from '@theme/Tabs'
910
import TabItem from '@theme/TabItem'
1011

11-
## 🚀 Migrate Personal Space Data to OpenCloud Using rclone
12+
# Migrate
13+
14+
Migrate Personal Space Data to OpenCloud Using rclone
1215

1316
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!
1417

15-
### 1. Generate users token using CLI or API
18+
## Generate users token using CLI or API
1619

1720
<Tabs>
1821
<TabItem value="opencloud" label="OpenCloud">
1922

20-
### Run OpenCloud with the following configuration
23+
## Run OpenCloud with the following configuration
2124

2225
Modify `.env` file:
2326

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

48-
---
49-
50-
### Generate user token using API
51+
## Generate user token using API
5152

5253
Requires additional configuration! Start the server with:
5354

@@ -79,7 +80,7 @@ Enable `auth-app` service:
7980
PROXY_ENABLE_APP_AUTH="true"
8081
```
8182

82-
### Generate user token using CLI
83+
## Generate user token using CLI
8384

8485
Access the oCIS container:
8586

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

96-
---
97-
98-
### Generate user token using API
97+
## Generate user token using API
9998

10099
Requires additional configuration! Start the server with:
101100

@@ -122,31 +121,25 @@ Create a new App Password
122121
</TabItem>
123122
</Tabs>
124123

125-
---
126-
127-
### 2. Install rclone
128-
129-
Download and install rclone by following the official guide: 🔗[**rclone.org/install**](https://rclone.org/install/)
124+
## Install rclone
130125

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

133-
### 3. Encrypt Authentication Tokens 🔒
128+
## Encrypt Authentication Tokens
134129

135130
```bash
136131
rclone obscure <token>
137132
```
138133

139-
---
140-
141-
### 4. Create the rclone Configuration 🛠️
134+
## Create the rclone Configuration
142135

143136
Edit the rclone configuration file:
144137

145138
```bash
146139
nano ~/.config/rclone/rclone.conf
147140
```
148141

149-
📌 Example Configuration:
142+
- Example Configuration
150143

151144
```bash
152145
[opencloud-admin]
@@ -205,9 +198,7 @@ description = nc-bob
205198

206199
```
207200

208-
---
209-
210-
### 5. Copy Data to OpenCloud
201+
## Copy Data to OpenCloud
211202

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

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

219210
```
220211

221-
---
222-
223-
### 6. Migration Results and Limitations
224-
225-
🎉 Congratulations! You have successfully migrated personal space data to OpenCloud! 🚀
226-
227-
✅ Successfully Migrated:
212+
## Migration Results and Limitations
228213

229-
- Personal space files
214+
Congratulations! You have successfully migrated personal space data to OpenCloud!
230215

231-
❌ Not Migrated:
216+
- Successfully Migrated
217+
- Personal space files
232218

233-
- Shared files
234-
- Public links
235-
- Project spaces
236-
- Trash-bin contents
237-
- File versions
238-
- Metadata
219+
- Not Migrated
220+
- Shared files
221+
- Public links
222+
- Project spaces
223+
- Trash-bin contents
224+
- File versions
225+
- Metadata
239226

240-
### 7. Security Step: Delete Tokens
227+
## Security Step: Delete Tokens
241228

242229
Once the migration is complete, please delete tokens to prevent unauthorized access!

docs/admin/maintenance/uninstall.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
---
22
sidebar_position: 4
33
id: uninstall
4-
title: 'Uninstall'
5-
description: 'Guide to uninstall OpenCloud.'
4+
title: Uninstall
5+
description: Guide to uninstall OpenCloud.
6+
draft: false
67
---
78

89
# Uninstall OpenCloud with Docker Compose
910

10-
> ⚠️ **Warning:** This guide will completely remove all OpenCloud data. Make sure to back up any important files before proceeding.
11+
:::warning
12+
This guide will completely remove all OpenCloud data. Make sure to back up any important files before proceeding.
13+
:::
1114

12-
---
13-
14-
## Step 1: Stop and Remove Docker Containers
15+
## Stop and Remove Docker Containers
1516

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

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

28-
## Step 2: Remove Docker Volumes
29+
## Remove Docker Volumes
2930

3031
To check your existing volumes:
3132

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

54-
## Step 3: Delete Mounted Directories (if used)
55+
## Delete Mounted Directories (if used)
5556

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

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

6364
Adjust the paths to match your setup.
6465

65-
## Step 4: Remove the Compose Project Folder (Optional)
66+
## Remove the Compose Project Folder (Optional)
6667

6768
If you want to delete the entire project directory:
6869

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,24 @@
11
---
22
sidebar_position: 3
33
id: release-notes
4-
title: 'Release Notes'
4+
title: Release Notes
5+
description: Release Notes
56
draft: false
67
---
78

8-
# 📦 Release Notes: Migration from v2.x.x to v3.0.0
9+
# Release Notes: Migration from v2.x.x to v3.0.0
910

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

14-
---
15-
1615
## Who Is Affected?
1716

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

2120
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.
2221

23-
---
24-
2522
## Key Changes
2623

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

33+
:::note
3634
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.
35+
:::

0 commit comments

Comments
 (0)