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
2 changes: 1 addition & 1 deletion docs/admin/20-getting-started/50-raspberry-pi.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ How to set up DDNS in the router:
- Search for the DDNS settings - these are usually located under Network, Internet or Dynamic DNS.
- Select No-IP as your provider from the list of supported DDNS services.
- Enter your No-IP credentials (username & password).
- Enter the hostname you previously created with No-IP (e.g. ocis-at-home.ddns.net).
- Enter the hostname you previously created with No-IP (e.g. opencloud-at-home.ddns.net).
- Save the settings and test the connection.

The router will now automatically update your public IP address at No-IP so that your Raspberry Pi always remains accessible under the selected subdomain.
Expand Down
6 changes: 0 additions & 6 deletions docs/admin/40-maintenance/10-update.md

This file was deleted.

95 changes: 95 additions & 0 deletions docs/admin/40-maintenance/10-upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
sidebar_position: 1
id: update
title: "Upgrade"
description: "🔄 Keep your setup up to date with the latest features!"
---

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

This guide provides steps to upgrade OpenCloud for both [docker](docs/admin/20-getting-started/30-docker.md) and [docker compose](docs/admin/20-getting-started/20-docker-compose.md)

### 1. Stop OpenCloud

Stop the currently running OpenCloud instance:

<Tabs groupId="deployment">
<TabItem value="docker" label="docker">
```Shell
docker stop opencloud
```
</TabItem>
<TabItem value="docker-compose" label="docker compose">
```Shell
docker compose stop
```
</TabItem>
</Tabs>

---

### 2. Backup Config and Data

It is recommended to create a backup before proceeding with the upgrade.

TODO: put backup link #103.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Heiko-Pohl I think the backup is part of upgrading guide. please put here backup link


---

### 3. Pull the new Opencloud version

```Shell
docker pull opencloudeu/opencloud:{tag}
```

---

### 4. Verify Configuration Changes

If upgrading from an older release, check for required configuration changes:

Go to inside the container:
```Shell
docker run --rm -it --entrypoint /bin/sh -v $HOME/opencloud/opencloud-config:/etc/opencloud opencloudeu/opencloud:{tag}
```

```Shell
opencloud init --diff
```

If you see `no changes, your config is up to date`, no further action is needed. Otherwise, update your `opencloud.yaml` file accordingly and start OpenCloud.

<img src={require("./img/init-diff.png").default} alt="init -diff" width="1920"/>

---

### 5. Start OpenCloud with updated image

<Tabs groupId="deployment">
<TabItem value="docker" label="docker">
```Shell
docker run \
--name opencloud \
--rm \
-it \
-p 9200:9200 \
-v $HOME/opencloud/opencloud-config:/etc/opencloud \
-v $HOME/opencloud/opencloud-data:/var/lib/opencloud \
-e OC_INSECURE=true \
-e PROXY_HTTP_ADDR=0.0.0.0:9200 \
-e OC_URL=https://localhost:9200 \
opencloudeu/opencloud:{tag}
```
</TabItem>
<TabItem value="docker-compose" label="docker compose">
```Shell
OC_DOCKER_IMAGE=opencloudeu/opencloud OC_DOCKER_TAG=tag docker compose up -d
```
</TabItem>
</Tabs>

---

### 6. Conclusion
Make sure that all previously created data, users, shared files, public links exist.
Binary file added docs/admin/40-maintenance/img/init-diff.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.