diff --git a/docs/admin/20-getting-started/50-raspberry-pi.md b/docs/admin/20-getting-started/50-raspberry-pi.md index cfe69cee..b2eeb94e 100644 --- a/docs/admin/20-getting-started/50-raspberry-pi.md +++ b/docs/admin/20-getting-started/50-raspberry-pi.md @@ -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. diff --git a/docs/admin/40-maintenance/10-update.md b/docs/admin/40-maintenance/10-update.md deleted file mode 100644 index 1ca83816..00000000 --- a/docs/admin/40-maintenance/10-update.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -sidebar_position: 1 -id: update -title: "Update" -draft: true ---- \ No newline at end of file diff --git a/docs/admin/40-maintenance/10-upgrade.md b/docs/admin/40-maintenance/10-upgrade.md new file mode 100644 index 00000000..071a5d1d --- /dev/null +++ b/docs/admin/40-maintenance/10-upgrade.md @@ -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: + + + + ```Shell + docker stop opencloud + ``` + + + ```Shell + docker compose stop + ``` + + + +--- + +### 2. Backup Config and Data + +It is recommended to create a backup before proceeding with the upgrade. + +TODO: put backup link #103. + +--- + +### 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. + +init -diff + +--- + +### 5. Start OpenCloud with updated image + + + + ```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} + ``` + + + ```Shell + OC_DOCKER_IMAGE=opencloudeu/opencloud OC_DOCKER_TAG=tag docker compose up -d + ``` + + + +--- + +### 6. Conclusion +Make sure that all previously created data, users, shared files, public links exist. diff --git a/docs/admin/40-maintenance/img/init-diff.png b/docs/admin/40-maintenance/img/init-diff.png new file mode 100644 index 00000000..94b6f0a0 Binary files /dev/null and b/docs/admin/40-maintenance/img/init-diff.png differ