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
156 changes: 156 additions & 0 deletions _data/pages_info.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3843,6 +3843,84 @@
"/docs/pe/user-guide/install/upgrade-instructions/centos/v4-2-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/centos/v4-2-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-0-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-0-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-1-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-1-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-2-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-2-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-3-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-3-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-4-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-4-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-5-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-5-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-6-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-6-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-7-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-7-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-8-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-8-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-9-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-9-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker/v4-0-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v4-0-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker/v4-1-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v4-1-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker/v4-2-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v4-2-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-0-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-0-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-1-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-1-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-2-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-2-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-3-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-3-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-4-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-4-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-5-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-5-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-6-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-6-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-7-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-7-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-8-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-8-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-0-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-0-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-1-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-1-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-2-x/":
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-2-x/"
redirect_from: []
"/docs/pe/user-guide/install/upgrade-instructions/":
url: "/docs/pe/user-guide/install/upgrade-instructions/"
redirect_from:
Expand Down Expand Up @@ -5163,6 +5241,84 @@
"/docs/user-guide/install/upgrade-instructions/centos/v4-2-x/":
url: "/docs/user-guide/install/upgrade-instructions/centos/v4-2-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker/v3-0-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-0-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker/v3-1-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-1-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker/v3-2-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-2-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker/v3-3-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-3-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker/v3-4-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-4-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker/v3-5-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-5-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker/v3-6-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-6-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker/v3-7-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-7-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker/v3-8-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-8-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker/v3-9-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-9-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker/v4-0-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker/v4-0-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker/v4-1-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker/v4-1-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker/v4-2-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker/v4-2-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-0-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-0-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-1-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-1-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-2-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-2-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-3-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-3-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-4-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-4-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-5-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-5-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-6-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-6-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-7-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-7-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-8-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-8-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker-compose/v4-0-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v4-0-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker-compose/v4-1-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v4-1-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/docker-compose/v4-2-x/":
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v4-2-x/"
redirect_from: []
"/docs/user-guide/install/upgrade-instructions/":
url: "/docs/user-guide/install/upgrade-instructions/"
redirect_from: []
Expand Down
14 changes: 14 additions & 0 deletions _includes/docs/pe/user-guide/install/docker-upgrade-steps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{% assign current_version = include.version %}

1. Change the version of the `thingsboard/tb-pe-node` and `thingsboard/tb-web-report` in the `docker-compose.yml` file to the **{{ current_version }}**.

2. Execute the following commands:

```bash
docker pull thingsboard/tb-pe-node:{{ current_version }}
docker pull thingsboard/tb-web-report:{{ current_version }}
docker compose stop thingsboard-pe
docker compose run --rm -e UPGRADE_TB=true thingsboard-pe
docker compose up -d
```
{: .copy-code}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{% assign current_version = include.version %}
{% assign from_version = include.fromversion %}

1. Change the parameter `TB_VERSION` in the `.env` file.

```.env
TB_VERSION={{ current_version }}
```

2. Execute the following commands:

```bash
./docker-stop-services.sh
./docker-upgrade-tb.sh --fromVersion={{ from_version }}
./docker-start-services.sh
```
{: .copy-code}
16 changes: 16 additions & 0 deletions _includes/docs/user-guide/install/docker-compose-upgrade-steps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{% assign current_version = include.version %}

1. Change the parameter `TB_VERSION` in the `.env` file.

```.env
TB_VERSION={{ current_version }}
```

2. Execute the following commands:

```bash
./docker-stop-services.sh
./docker-upgrade-tb.sh
./docker-start-services.sh
```
{: .copy-code}
13 changes: 13 additions & 0 deletions _includes/docs/user-guide/install/docker-upgrade-steps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{% assign current_version = include.version %}

1. Change the version of the `thingsboard/tb-node` in the `docker-compose.yml` file to the **{{ current_version }}**.

2. Execute the following commands:

```bash
docker pull thingsboard/tb-node:{{ current_version }}
docker compose stop thingsboard-ce
docker compose run --rm -e UPGRADE_TB=true thingsboard-ce
docker compose up -d
```
{: .copy-code}
4 changes: 2 additions & 2 deletions _includes/upgrade-instructions-table.liquid
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,10 @@
<a href="/docs/{{ docsPrefix }}user-guide/install/upgrade-instructions/windows/{{ versionFamily }}/{{ hashLinkUpgrade }}" data-tooltip="Windows Instructions">
<img src="/images/windows.svg" alt="Upgrade Windows Instructions">
</a>
<a href="/docs/user-guide/install/{{ docsPrefix }}docker/#upgrading" data-tooltip="Docker Instructions">
<a href="/docs/{{ docsPrefix }}user-guide/install/upgrade-instructions/docker/{{ versionFamily }}/{{ hashLinkUpgrade }}" data-tooltip="Docker Instructions">
<img src="/images/docker.svg" alt="Upgrade Docker Instructions">
</a>
<a class="right-link" href="/docs/user-guide/install/{{ docsPrefix }}cluster/docker-compose-setup/#upgrading" data-tooltip="Docker Compose Instructions">
<a href="/docs/{{ docsPrefix }}user-guide/install/upgrade-instructions/docker-compose/{{ versionFamily }}/{{ hashLinkUpgrade }}" data-tooltip="Docker Compose Instructions">
<img width="24" height="24" src="/images/install/cluster/docker-compose.svg" alt="Docker Compose Instructions">
</a>
</div>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
layout: docwithnav-pe
title: ThingsBoard PE v3.0.x upgrade instructions for Docker Compose
description: ThingsBoard PE v3.0.x upgrade guide for Docker Compose
active-menu-item-click: "true"
breadcrumbs: true
breadcrumbs-steps: 2
breadcrumbs-show: 2

---

* TOC
{:toc}

### Upgrading ThingsBoard PE to 3.0.1

**NOTE**: These upgrade steps are applicable for ThingsBoard version 3.0PE. In order to upgrade to 3.0.1PE you need to [**upgrade to 3.0PE first**](#upgrading-thingsboard-pe-to-30).

{% include templates/install/tb-30-update.md %}

{% capture update_manifests_note %}
We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/master) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release.
<br>
<br>
If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files.
{% endcapture %}
{% include templates/warn-banner.md content=update_manifests_note %}

#### ThingsBoard PE service upgrade

{% include docs/user-guide/install/docker-compose-upgrade-steps-fromversion.md version="3.0.1PE" fromversion="3.0.0" %}

### Upgrading ThingsBoard PE to 3.0

{% capture update_manifests_note %}
We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/master) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release.
<br>
<br>
If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files.
{% endcapture %}
{% include templates/warn-banner.md content=update_manifests_note %}

#### ThingsBoard PE service upgrade

{% include docs/user-guide/install/docker-compose-upgrade-steps-fromversion.md version="3.0.0PE" fromversion="2.5.0" %}

Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
layout: docwithnav-pe
title: ThingsBoard PE v3.1.x upgrade instructions for Docker Compose
description: ThingsBoard PE v3.1.x upgrade guide for Docker Compose
active-menu-item-click: "true"
breadcrumbs: true
breadcrumbs-steps: 2
breadcrumbs-show: 2

---

* TOC
{:toc}

### Upgrading ThingsBoard PE to 3.1.1

**NOTE**: These upgrade steps are applicable for ThingsBoard version 3.1PE. In order to upgrade to 3.1.1PE you need to [**upgrade to 3.1PE first**](#upgrading-thingsboard-pe-to-31).

{% capture update_manifests_note %}
We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/master) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release.
<br>
<br>
If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files.
{% endcapture %}
{% include templates/warn-banner.md content=update_manifests_note %}

#### ThingsBoard PE service upgrade

{% include docs/user-guide/install/docker-compose-upgrade-steps-fromversion.md version="3.1.1PE" fromversion="3.1.0" %}

### Upgrading ThingsBoard PE to 3.1

**NOTE**: These upgrade steps are applicable for ThingsBoard version 3.0.1PE. In order to upgrade to 3.1PE you need to [**upgrade to 3.0.1PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-0-x/#upgrading-thingsboard-pe-to-301).

{% capture update_manifests_note %}
We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/master) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release.
<br>
<br>
If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files.
{% endcapture %}
{% include templates/warn-banner.md content=update_manifests_note %}

#### ThingsBoard PE service upgrade

{% include docs/user-guide/install/docker-compose-upgrade-steps-fromversion.md version="3.1.0PE" fromversion="3.0.1" %}
Loading