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
24 changes: 12 additions & 12 deletions docs/admin/maintenance/upgrade/upgrade-4.0.0.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
sidebar_position: 2
id: upgrade-4.0.0
title: Upgrade 4.0.0
description: Upgrading to 4.0.0
id: upgrade-4.0.x
title: Upgrade 4.0.x
description: Upgrading to 4.0.x
draft: false
---

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

# Upgrading to OpenCloud 4.0.0
# Upgrading to OpenCloud 4.0.x

This guide explains how to upgrade from the previous stable opencloud_full Compose setup to the new
[opencloud-compose](https://github.com/opencloud-eu/opencloud-compose.git) repository structure.
Expand All @@ -18,7 +18,7 @@ It covers both types of persistent storage used in earlier deployments:
- Bind mounts: host directories mapped into containers.
- Docker named volumes: volumes managed directly by Docker.

Following this guide, you can safely migrate to the stable v4.0.0 release of OpenCloud.
Following this guide, you can safely migrate to the stable v4.0.x release of OpenCloud.

## Before You Begin

Expand Down Expand Up @@ -90,10 +90,10 @@ docker compose stop

</Tabs>

## Pull the 4.0.0 Production Release Image
## Pull the 4.0.x Production Release Image

```bash
docker pull opencloudeu/opencloud:4.0.0
docker pull opencloudeu/opencloud:4.0.x
```

## Update Deployment Configuration
Expand Down Expand Up @@ -126,15 +126,15 @@ Go inside the container:
If your config is stored in host directories (change `<your-home-directory>` to your home directory. In our example it is `/mnt` ):

```bash
docker run --rm -it --entrypoint /bin/sh -v <your-home-directory>/opencloud/opencloud-config:/etc/opencloud opencloudeu/opencloud:4.0.0
docker run --rm -it --entrypoint /bin/sh -v <your-home-directory>/opencloud/opencloud-config:/etc/opencloud opencloudeu/opencloud:4.0.x
```

or, if you use Docker Named Volumes (replace `<your-named-volume>`with your volume name. In our example it is `opencloud_full_opencloud-config`):

```bash
docker run --rm -it --entrypoint /bin/sh \
-v <your-named-volume>:/etc/opencloud \
opencloudeu/opencloud:4.0.0
opencloudeu/opencloud:4.0.x
```

Check for configuration changes:
Expand Down Expand Up @@ -167,7 +167,7 @@ diff written to /etc/opencloud/opencloud.config.patch

Apply any necessary changes to `/etc/opencloud/opencloud.yaml` based on the diff output. In this example, add `url_signing_secret` to your `opencloud.yaml`.

## Start OpenCloud (v4.0.0)
## Start OpenCloud (v4.0.x)

<Tabs>

Expand All @@ -184,7 +184,7 @@ docker run \
-e OC_INSECURE=true \
-e PROXY_HTTP_ADDR=0.0.0.0:9200 \
-e OC_URL=https://localhost:9200 \
opencloudeu/opencloud:4.0.0
opencloudeu/opencloud:4.0.x
```

</TabItem>
Expand Down Expand Up @@ -222,7 +222,7 @@ docker compose up -d

## Verification

Your OpenCloud instance should now be running on `v4.0.0`.
Your OpenCloud instance should now be running on `v4.0.x`.

### Essential Checks

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
sidebar_position: 2
id: upgrade-4.0.0
title: Upgrade 4.0.0
description: Upgrading to 4.0.0
id: upgrade-4.0.x
title: Upgrade 4.0.x
description: Upgrading to 4.0.x
draft: false
---

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

# Upgrading to OpenCloud 4.0.0
# Upgrading to OpenCloud 4.0.x

This guide explains how to upgrade from the previous stable opencloud_full Compose setup to the new
[opencloud-compose](https://github.com/opencloud-eu/opencloud-compose.git) repository structure.
Expand All @@ -18,7 +18,7 @@ It covers both types of persistent storage used in earlier deployments:
- Bind mounts: host directories mapped into containers.
- Docker named volumes: volumes managed directly by Docker.

Following this guide, you can safely migrate to the stable v4.0.0 release of OpenCloud.
Following this guide, you can safely migrate to the stable v4.0.x release of OpenCloud.

## Before You Begin

Expand All @@ -31,7 +31,8 @@ Following this guide, you can safely migrate to the stable v4.0.0 release of Ope

:::important
Important: Always create a backup before upgrading to prevent data loss.
We strongly recommend following the [backup documentation](../backup) and creating copies of your configuration and data directories.
We strongly recommend following the [backup documentation](admin/maintenance/backup.md)
and creating copies of your configuration and data directories.
:::

<Tabs> <TabItem value="bind-mounts" label="Using Bind Mounts">
Expand Down Expand Up @@ -89,10 +90,10 @@ docker compose stop

</Tabs>

## Pull the 4.0.0 Production Release Image
## Pull the 4.0.x Production Release Image

```bash
docker pull opencloudeu/opencloud:4.0.0
docker pull opencloudeu/opencloud:4.0.x
```

## Update Deployment Configuration
Expand All @@ -112,7 +113,7 @@ cd opencloud-compose

### Migrate Environment Variables

Transfer your existing environment variables to the new opencloud-compose structure. Refer to the [Docker Compose configuration documentation](../../getting-started/container/docker-compose/docker-compose-base.md) for detailed instructions.
Transfer your existing environment variables to the new opencloud-compose structure. Refer to the [Docker Compose configuration documentation](admin/getting-started/container/docker-compose/docker-compose-base.md) for detailed instructions.

</TabItem>

Expand All @@ -125,15 +126,15 @@ Go inside the container:
If your config is stored in host directories (change `<your-home-directory>` to your home directory. In our example it is `/mnt` ):

```bash
docker run --rm -it --entrypoint /bin/sh -v <your-home-directory>/opencloud/opencloud-config:/etc/opencloud opencloudeu/opencloud:4.0.0
docker run --rm -it --entrypoint /bin/sh -v <your-home-directory>/opencloud/opencloud-config:/etc/opencloud opencloudeu/opencloud:4.0.x
```

or, if you use Docker Named Volumes (replace `<your-named-volume>`with your volume name. In our example it is `opencloud_full_opencloud-config`):

```bash
docker run --rm -it --entrypoint /bin/sh \
-v <your-named-volume>:/etc/opencloud \
opencloudeu/opencloud:4.0.0
opencloudeu/opencloud:4.0.x
```

Check for configuration changes:
Expand Down Expand Up @@ -166,7 +167,7 @@ diff written to /etc/opencloud/opencloud.config.patch

Apply any necessary changes to `/etc/opencloud/opencloud.yaml` based on the diff output. In this example, add `url_signing_secret` to your `opencloud.yaml`.

## Start OpenCloud (v4.0.0)
## Start OpenCloud (v4.0.x)

<Tabs>

Expand All @@ -183,7 +184,7 @@ docker run \
-e OC_INSECURE=true \
-e PROXY_HTTP_ADDR=0.0.0.0:9200 \
-e OC_URL=https://localhost:9200 \
opencloudeu/opencloud:4.0.0
opencloudeu/opencloud:4.0.x
```

</TabItem>
Expand Down Expand Up @@ -221,7 +222,7 @@ docker compose up -d

## Verification

Your OpenCloud instance should now be running on `v4.0.0`.
Your OpenCloud instance should now be running on `v4.0.x`.

### Essential Checks

Expand Down