Skip to content

Commit 5b4ad29

Browse files
authored
Merge pull request thingsboard#1446 from trikimiki/master
update and refactor monolith installation guides
2 parents 4b5e7a3 + 70af8b3 commit 5b4ad29

File tree

11 files changed

+55
-93
lines changed

11 files changed

+55
-93
lines changed
Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,9 @@
11
Then, press "Ctrl+D" to return to main user console.
22

3-
After configuring the password, edit the pg_hba.conf to use MD5 authentication with the postgres user.
4-
5-
Edit pg_hba.conf file:
6-
7-
```bash
8-
sudo nano /var/lib/pgsql/15/data/pg_hba.conf
9-
10-
```
11-
{: .copy-code}
12-
13-
Locate the following lines:
14-
15-
```text
16-
# IPv4 local connections:
17-
host all all 127.0.0.1/32 ident
18-
```
19-
20-
Replace `ident` with `md5`:
21-
22-
```text
23-
host all all 127.0.0.1/32 md5
24-
```
25-
26-
Finally, you should restart the PostgreSQL service to initialize the new configuration:
27-
28-
```bash
29-
sudo systemctl restart postgresql-15.service
30-
31-
```
32-
{: .copy-code}
33-
34-
Connect to the database to create thingsboard DB:
3+
After configuring the password, connect to the database to create thingsboard DB:
354

365
```bash
376
psql -U postgres -d postgres -h 127.0.0.1 -W
38-
397
```
408
{: .copy-code}
419

@@ -44,6 +12,5 @@ Execute create database statement
4412
```bash
4513
CREATE DATABASE thingsboard;
4614
\q
47-
4815
```
4916
{: .copy-code}

_includes/templates/install/memory-on-slow-machines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sudo nano /etc/thingsboard/conf/thingsboard.conf
88
Add the following lines to the configuration file.
99

1010
```bash
11-
# Update ThingsBoard memory usage and restrict it to 256MB in /etc/thingsboard/conf/thingsboard.conf
12-
export JAVA_OPTS="$JAVA_OPTS -Xms256M -Xmx256M"
11+
# Update ThingsBoard memory usage and restrict it to 2G in /etc/thingsboard/conf/thingsboard.conf
12+
export JAVA_OPTS="$JAVA_OPTS -Xms2G -Xmx2G"
1313
```
1414
{: .copy-code}

_includes/templates/install/postgres-install-rhel.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,27 @@ sudo yum update
66
```
77
{: .copy-code}
88

9-
**For CentOS/RHEL 7:**
9+
Install the repository.
10+
11+
**For CentOS/RHEL 8:**
1012

1113
```bash
1214
# Install the repository RPM:
13-
sudo yum -y install https://download.postgresql.org/pub/repos/yum/reporpms/EL-7-x86_64/pgdg-redhat-repo-latest.noarch.rpm
14-
# Install packages
15-
sudo yum -y install epel-release yum-utils
16-
sudo yum-config-manager --enable pgdg15
17-
sudo yum install postgresql15-server postgresql15
18-
# Initialize your PostgreSQL DB
19-
sudo /usr/pgsql-15/bin/postgresql-15-setup initdb
20-
sudo systemctl start postgresql-15
21-
# Optional: Configure PostgreSQL to start on boot
22-
sudo systemctl enable --now postgresql-15
23-
15+
sudo yum -y install https://download.postgresql.org/pub/repos/yum/reporpms/EL-8-x86_64/pgdg-redhat-repo-latest.noarch.rpm
2416
```
2517
{: .copy-code}
2618

27-
**For RHEL 8 and derivatives (Alma, Rocky, Oracle):**
19+
**For CentOS/RHEL 9:**
2820

2921
```bash
3022
# Install the repository RPM:
31-
sudo yum -y install https://download.postgresql.org/pub/repos/yum/reporpms/EL-8-x86_64/pgdg-redhat-repo-latest.noarch.rpm
23+
sudo yum -y install https://download.postgresql.org/pub/repos/yum/reporpms/EL-9-x86_64/pgdg-redhat-repo-latest.noarch.rpm
24+
```
25+
{: .copy-code}
26+
27+
Install the package.
28+
29+
```bash
3230
# Install packages
3331
sudo dnf -qy module disable postgresql
3432
sudo dnf -y install postgresql15 postgresql15-server
@@ -37,7 +35,6 @@ sudo /usr/pgsql-15/bin/postgresql-15-setup initdb
3735
sudo systemctl start postgresql-15
3836
# Optional: Configure PostgreSQL to start on boot
3937
sudo systemctl enable --now postgresql-15
40-
4138
```
4239
{: .copy-code}
4340

_includes/templates/install/windows-memory-on-slow-machines.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,6 @@ and change them to
2121
<startargument>-Xms256m</startargument>
2222
<startargument>-Xmx256m</startargument>
2323
```
24+
25+
change "256m" to approximately 1/3rd of your total RAM (in MB)
2426
{: .copy-code}

docs/user-guide/install/pe/rhel.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,32 +14,30 @@ description: Installing ThingsBoard PE on CentOS/RHEL
1414

1515
### Prerequisites
1616

17-
This guide describes how to install ThingsBoard on RHEL/CentOS 7/8.
17+
This guide describes how to install ThingsBoard on RHEL 8/9, CentOS 8/9, or their derivatives (Alma, Rocky, Oracle, etc).
1818
Hardware requirements depend on chosen database and amount of devices connected to the system.
19-
To run ThingsBoard and PostgreSQL on a single machine you will need at least 1Gb of RAM.
19+
To run ThingsBoard and PostgreSQL on a single machine you will need at least 4Gb of RAM.
2020
To run ThingsBoard and Cassandra on a single machine you will need at least 8Gb of RAM.
2121

2222
Before continue to installation execute the following commands in order to install necessary tools:
2323

24-
**For CentOS 7:**
24+
**For CentOS 8:**
2525

2626
```bash
2727
# Install wget
2828
sudo yum install -y nano wget
29-
# Add latest EPEL release for CentOS 7
30-
sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
31-
29+
# Add latest EPEL release for CentOS 8
30+
sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
3231
```
3332
{: .copy-code}
3433

35-
**For CentOS 8:**
34+
**For CentOS 9:**
3635

3736
```bash
3837
# Install wget
3938
sudo yum install -y nano wget
40-
# Add latest EPEL release for CentOS 8
41-
sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
42-
39+
# Add latest EPEL release for CentOS 9
40+
sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
4341
```
4442
{: .copy-code}
4543

@@ -120,7 +118,7 @@ Confluent Cloud <small>(Event Streaming Platform based on Kafka)</small>%,%confl
120118

121119
{% include content-toggle.liquid content-toggle-id="ubuntuThingsboardQueue" toggle-spec=contenttogglespecqueue %}
122120

123-
### Step 6. [Optional] Memory update for slow machines (1GB of RAM)
121+
### Step 6. [Optional] Memory update for slow machines (4GB of RAM)
124122

125123
{% include templates/install/memory-on-slow-machines.md %}
126124

@@ -142,7 +140,7 @@ sudo firewall-cmd --reload
142140
{% include templates/start-service.md %}
143141

144142
{% capture 90-sec-ui %}
145-
Please allow up to 90 seconds for the Web UI to start. This is applicable only for slow machines with 1-2 CPUs or 1-2 GB RAM.{% endcapture %}
143+
Please allow up to 90 seconds for the Web UI to start.{% endcapture %}
146144
{% include templates/info-banner.md content=90-sec-ui %}
147145

148146
### Step 9. Install ThingsBoard WebReport component

docs/user-guide/install/pe/ubuntu.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ description: Installing ThingsBoard on Ubuntu
1414

1515
### Prerequisites
1616

17-
This guide describes how to install ThingsBoard on Ubuntu 18.04 LTS / Ubuntu 20.04 LTS.
17+
This guide describes how to install ThingsBoard on Ubuntu 20.04 LTS / 22.04 LTS.
1818
Hardware requirements depend on chosen database and amount of devices connected to the system.
19-
To run ThingsBoard and PostgreSQL on a single machine you will need at least 1Gb of RAM.
19+
To run ThingsBoard and PostgreSQL on a single machine you will need at least 4Gb of RAM.
2020
To run ThingsBoard and Cassandra on a single machine you will need at least 8Gb of RAM.
2121

2222
### Step 1. Install Java 11 (OpenJDK)
@@ -96,7 +96,7 @@ Confluent Cloud <small>(Event Streaming Platform based on Kafka)</small>%,%confl
9696

9797
{% include content-toggle.liquid content-toggle-id="ubuntuThingsboardQueue" toggle-spec=contenttogglespecqueue %}
9898

99-
### Step 6. [Optional] Memory update for slow machines (1GB of RAM)
99+
### Step 6. [Optional] Memory update for slow machines (4GB of RAM)
100100

101101
{% include templates/install/memory-on-slow-machines.md %}
102102

@@ -109,7 +109,7 @@ Confluent Cloud <small>(Event Streaming Platform based on Kafka)</small>%,%confl
109109
{% include templates/start-service.md %}
110110

111111
{% capture 90-sec-ui %}
112-
Please allow up to 90 seconds for the Web UI to start. This is applicable only for slow machines with 1-2 CPUs or 1-2 GB RAM.{% endcapture %}
112+
Please allow up to 90 seconds for the Web UI to start.{% endcapture %}
113113
{% include templates/info-banner.md content=90-sec-ui %}
114114

115115
### Step 9. Install ThingsBoard WebReport component

docs/user-guide/install/pe/windows.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ description: Installing ThingsBoard on Windows
1717
### Prerequisites
1818

1919
This guide describes how to install ThingsBoard on a Windows machine.
20-
Instructions below are provided for Windows 10/8.1/8/7 32-bit/64-bit.
20+
Instructions below are provided for Windows 11/10.
2121
Hardware requirements depend on chosen database and amount of devices connected to the system.
22-
To run ThingsBoard and PostgreSQL on a single machine you will need at least 2Gb of RAM.
22+
To run ThingsBoard and PostgreSQL on a single machine you will need at least 4Gb of RAM.
2323
To run ThingsBoard and Cassandra on a single machine you will need at least 8Gb of RAM.
2424

2525
### Step 1. Install Java 11 (OpenJDK)
@@ -93,7 +93,7 @@ Confluent Cloud <small>(Event Streaming Platform based on Kafka)</small>%,%confl
9393
9494
{% include content-toggle.liquid content-toggle-id="windowsThingsboardQueue" toggle-spec=contenttogglespecqueue %}
9595
96-
### Step 6. [Optional] Memory update for slow machines (1GB of RAM)
96+
### Step 6. [Optional] Memory update for slow machines
9797
9898
{% include templates/install/windows-memory-on-slow-machines.md %}
9999
@@ -121,7 +121,7 @@ ThingsBoard installed successfully!
121121
{% include templates/windows-start-service.md %}
122122

123123
{% capture 90-sec-ui %}
124-
Please allow up to 90 seconds for the Web UI to start. This is applicable only for slow machines with 1-2 CPUs or 1-2 GB RAM.{% endcapture %}
124+
Please allow up to 90 seconds for the Web UI to start.{% endcapture %}
125125
{% include templates/info-banner.md content=90-sec-ui %}
126126

127127
### Step 9. Install ThingsBoard Web Report Server component

docs/user-guide/install/rhel.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,32 +12,30 @@ description: Installing ThingsBoard CE on CentOS/RHEL
1212

1313
### Prerequisites
1414

15-
This guide describes how to install ThingsBoard on RHEL/CentOS 7/8.
15+
This guide describes how to install ThingsBoard on RHEL 8/9, CentOS 8/9, or their derivatives (Alma, Rocky, Oracle, etc).
1616
Hardware requirements depend on chosen database and amount of devices connected to the system.
17-
To run ThingsBoard and PostgreSQL on a single machine you will need at least 1Gb of RAM.
17+
To run ThingsBoard and PostgreSQL on a single machine you will need at least 4Gb of RAM.
1818
To run ThingsBoard and Cassandra on a single machine you will need at least 8Gb of RAM.
1919

2020
Before continue to installation execute the following commands in order to install necessary tools:
2121

22-
**For CentOS 7:**
22+
**For CentOS 8:**
2323

2424
```bash
2525
# Install wget
2626
sudo yum install -y nano wget
27-
# Add latest EPEL release for CentOS 7
28-
sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
29-
27+
# Add latest EPEL release for CentOS 8
28+
sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
3029
```
3130
{: .copy-code}
3231

33-
**For CentOS 8:**
32+
**For CentOS 9:**
3433

3534
```bash
3635
# Install wget
3736
sudo yum install -y nano wget
38-
# Add latest EPEL release for CentOS 8
39-
sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
40-
37+
# Add latest EPEL release for CentOS 9
38+
sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
4139
```
4240
{: .copy-code}
4341

@@ -88,7 +86,7 @@ Confluent Cloud <small>(Event Streaming Platform based on Kafka)</small>%,%confl
8886

8987
{% include content-toggle.liquid content-toggle-id="ubuntuThingsboardQueue" toggle-spec=contenttogglespecqueue %}
9088

91-
### Step 5. [Optional] Memory update for slow machines (1GB of RAM)
89+
### Step 5. [Optional] Memory update for slow machines (4GB of RAM)
9290

9391
{% include templates/install/memory-on-slow-machines.md %}
9492

@@ -111,7 +109,7 @@ sudo firewall-cmd --reload
111109
{% include templates/start-service.md %}
112110

113111
{% capture 90-sec-ui %}
114-
Please allow up to 90 seconds for the Web UI to start. This is applicable only for slow machines with 1-2 CPUs or 1-2 GB RAM.{% endcapture %}
112+
Please allow up to 90 seconds for the Web UI to start.{% endcapture %}
115113
{% include templates/info-banner.md content=90-sec-ui %}
116114

117115
### Post-installation steps

docs/user-guide/install/rpi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Confluent Cloud <small>(Event Streaming Platform based on Kafka)</small>%,%confl
6666

6767
{% include content-toggle.liquid content-toggle-id="ubuntuThingsboardQueue" toggle-spec=contenttogglespecqueue %}
6868

69-
### Step 5. Memory update for slow machines (1GB of RAM)
69+
### Step 5. Memory update for slow machines (4GB of RAM)
7070

7171
{% include templates/install/memory-on-slow-machines.md %}
7272

@@ -79,7 +79,7 @@ Confluent Cloud <small>(Event Streaming Platform based on Kafka)</small>%,%confl
7979
{% include templates/start-service.md %}
8080

8181
{% capture 90-sec-ui %}
82-
Please allow up to 240 seconds for the Web UI to start. This is applicable only for slow machines with 1-2 CPUs or 1-2 GB RAM.{% endcapture %}
82+
Please allow up to 90 seconds for the Web UI to start.{% endcapture %}
8383
{% include templates/info-banner.md content=90-sec-ui %}
8484

8585
### Troubleshooting

docs/user-guide/install/ubuntu.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ description: Installing ThingsBoard CE on Ubuntu Server
1212

1313
### Prerequisites
1414

15-
This guide describes how to install ThingsBoard on Ubuntu 18.04 LTS / Ubuntu 20.04 LTS.
15+
This guide describes how to install ThingsBoard on Ubuntu 20.04 LTS / 22.04 LTS.
1616
Hardware requirements depend on chosen database and amount of devices connected to the system.
17-
To run ThingsBoard and PostgreSQL on a single machine you will need at least 1Gb of RAM.
17+
To run ThingsBoard and PostgreSQL on a single machine you will need at least 4Gb of RAM.
1818
To run ThingsBoard and Cassandra on a single machine you will need at least 8Gb of RAM.
1919

2020
### Step 1. Install Java 11 (OpenJDK)
@@ -64,7 +64,7 @@ Confluent Cloud <small>(Event Streaming Platform based on Kafka)</small>%,%confl
6464

6565
{% include content-toggle.liquid content-toggle-id="ubuntuThingsboardQueue" toggle-spec=contenttogglespecqueue %}
6666

67-
### Step 5. [Optional] Memory update for slow machines (1GB of RAM)
67+
### Step 5. [Optional] Memory update for slow machines (4GB of RAM)
6868

6969
{% include templates/install/memory-on-slow-machines.md %}
7070

@@ -77,7 +77,7 @@ Confluent Cloud <small>(Event Streaming Platform based on Kafka)</small>%,%confl
7777
{% include templates/start-service.md %}
7878

7979
{% capture 90-sec-ui %}
80-
Please allow up to 90 seconds for the Web UI to start. This is applicable only for slow machines with 1-2 CPUs or 1-2 GB RAM.{% endcapture %}
80+
Please allow up to 90 seconds for the Web UI to start.{% endcapture %}
8181
{% include templates/info-banner.md content=90-sec-ui %}
8282

8383
### Post-installation steps

docs/user-guide/install/windows.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ description: Installing ThingsBoard on Windows
1717
### Prerequisites
1818

1919
This guide describes how to install ThingsBoard on a Windows machine.
20-
Instructions below are provided for Windows 10/8.1/8/7 32-bit/64-bit.
20+
Instructions below are provided for Windows 11/10.
2121
Hardware requirements depend on chosen database and amount of devices connected to the system.
22-
To run ThingsBoard and PostgreSQL on a single machine you will need at least 2Gb of RAM.
22+
To run ThingsBoard and PostgreSQL on a single machine you will need at least 4Gb of RAM.
2323
To run ThingsBoard and Cassandra on a single machine you will need at least 8Gb of RAM.
2424

2525
### Step 1. Install Java 11 (OpenJDK)
@@ -62,7 +62,7 @@ Confluent Cloud <small>(Event Streaming Platform based on Kafka)</small>%,%confl
6262

6363
{% include content-toggle.liquid content-toggle-id="windowsThingsboardQueue" toggle-spec=contenttogglespecqueue %}
6464

65-
### Step 5. [Optional] Memory update for slow machines (1GB of RAM)
65+
### Step 5. [Optional] Memory update for slow machines (4GB of RAM)
6666

6767
{% include templates/install/windows-memory-on-slow-machines.md %}
6868

@@ -90,7 +90,7 @@ ThingsBoard installed successfully!
9090
{% include templates/windows-start-service.md %}
9191

9292
{% capture 90-sec-ui %}
93-
Please allow up to 90 seconds for the Web UI to start. This is applicable only for slow machines with 1-2 CPUs or 1-2 GB RAM.{% endcapture %}
93+
Please allow up to 90 seconds for the Web UI to start.{% endcapture %}
9494
{% include templates/info-banner.md content=90-sec-ui %}
9595

9696

0 commit comments

Comments
 (0)