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
13 changes: 7 additions & 6 deletions _partials/_add-timescaledb-to-a-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,13 @@
You see the list of installed extensions:

```sql
List of installed extensions
Name | Version | Schema | Description
-------------+---------+------------+---------------------------------------------------------------------------------------
plpgsql | 1.0 | pg_catalog | PL/pgSQL procedural language
timescaledb | 2.17.2 | public | Enables scalable inserts and complex queries for time-series data (Community Edition)
List of installed extensions
Name | Version | Default version | Schema | Description
-------------+---------+-----------------+------------+---------------------------------------------------------------------------------------
plpgsql | 1.0 | 1.0 | pg_catalog | PL/pgSQL procedural language
timescaledb | 2.24.0 | 2.24.0 | public | Enables scalable inserts and complex queries for time-series data (Community Edition)
(2 rows)
```
Press q to exit the list of extensions.
Press `\q` to exit the list of extensions.

</Procedure>
2 changes: 1 addition & 1 deletion _partials/_install-self-hosted-debian-based-end.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
1. **Install TimescaleDB**

```bash
sudo apt install timescaledb-2-postgresql-17 postgresql-client-17
sudo apt install timescaledb-2-postgresql-18 postgresql-client-18
```

To install a specific $TIMESCALE_DB [release][releases-page], set the version. For example:
Expand Down
2 changes: 1 addition & 1 deletion _partials/_install-self-hosted-debian-based.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
1. **Install TimescaleDB**

```bash
sudo apt install timescaledb-2-postgresql-17 postgresql-client-17
sudo apt install timescaledb-2-postgresql-18 postgresql-client-18
```

To install a specific $TIMESCALE_DB [release][releases-page], set the version. For example:
Expand Down
53 changes: 33 additions & 20 deletions _partials/_install-self-hosted-docker-based.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@
$TIMESCALE_DB experience. It uses [Ubuntu][ubuntu], includes
[$TOOLKIT_LONG](https://github.com/timescale/timescaledb-toolkit), and support for PostGIS and Patroni.

To install the latest release based on $PG 17:
To install the latest release based on $PG 18:

```
docker pull timescale/timescaledb-ha:pg17
docker pull timescale/timescaledb-ha:pg18
```

$TIMESCALE_DB is pre-created in the default $PG database and is added by default to any new database you create in this image.
Expand All @@ -22,11 +22,15 @@

Replace `</a/local/data/folder>` with the path to the folder you want to keep your data in the following command.
```
docker run -d --name timescaledb -p 5432:5432 -v </a/local/data/folder>:/pgdata -e PGDATA=/pgdata -e POSTGRES_PASSWORD=password timescale/timescaledb-ha:pg17
docker run -d --name timescaledb -p 5432:5432 -v </a/local/data/folder>:/pgdata -e PGDATA=/pgdata -e POSTGRES_PASSWORD=password timescale/timescaledb-ha:pg18
```

If you are running multiple container instances, change the port each Docker instance runs on.

<Highlight type="note">
If you have a local $PG instance already running on port 5432, change the Docker port mapping to avoid conflicts. For example, use `-p 5433:5432` and adjust the connection string accordingly.
</Highlight>

On UNIX-based systems, Docker modifies Linux IP tables to bind the container. If your system uses Linux Uncomplicated Firewall (UFW), Docker may
[override your UFW port binding settings][override-binding]. To prevent this, add `DOCKER_OPTS="--iptables=false"` to `/etc/default/docker`.

Expand All @@ -35,9 +39,11 @@
The default user and database are both `postgres`. You set the password in `POSTGRES_PASSWORD` in the previous step. The default command to connect to $PG is:

```bash
psql -d "postgres://postgres:password@localhost/postgres"
psql -d "postgres://postgres:password@127.0.0.1:5432/postgres"
```

If you changed the port mapping in step 2 (e.g., to 5433), update the port in the connection string accordingly.

1. **Check that $TIMESCALE_DB is installed**

```sql
Expand All @@ -47,11 +53,11 @@
You see the list of installed extensions:

```sql
Name | Version | Schema | Description
---------------------+---------+------------+---------------------------------------------------------------------------------------
plpgsql | 1.0 | pg_catalog | PL/pgSQL procedural language
timescaledb | 2.20.3 | public | Enables scalable inserts and complex queries for time-series data (Community Edition)
timescaledb_toolkit | 1.21.0 | public | Library of analytical hyperfunctions, time-series pipelining, and other SQL utilities
Name | Version | Default version | Schema | Description
---------------------+---------+-----------------+------------+---------------------------------------------------------------------------------------
plpgsql | 1.0 | 1.0 | pg_catalog | PL/pgSQL procedural language
timescaledb | 2.24.0 | 2.24.0 | public | Enables scalable inserts and complex queries for time-series data (Community Edition)
timescaledb_toolkit | 1.22.0 | 1.22.0 | public | Library of analytical hyperfunctions, time-series pipelining, and other SQL utilities
(3 rows)
```

Expand All @@ -66,7 +72,7 @@ outside world, you can bind to `127.0.0.1` instead of the public interface, usin

```bash
docker run -d --name timescaledb -p 127.0.0.1:5432:5432 \
-v </a/local/data/folder>:/pgdata -e PGDATA=/pgdata -e POSTGRES_PASSWORD=password timescale/timescaledb-ha:pg17
-v </a/local/data/folder>:/pgdata -e PGDATA=/pgdata -e POSTGRES_PASSWORD=password timescale/timescaledb-ha:pg18
```

If you don't want to install `psql` and other $PG client tools locally,
Expand Down Expand Up @@ -105,7 +111,7 @@ information, see the [Docker documentation on logs][docker-logs].
To install the latest release based on $PG 17:

```
docker pull timescale/timescaledb:latest-pg17
docker pull timescale/timescaledb:latest-pg18
```

$TIMESCALE_DB is pre-created in the default $PG database and added by default to any new database you create in this image.
Expand All @@ -115,21 +121,27 @@ information, see the [Docker documentation on logs][docker-logs].

```
docker run -v </a/local/data/folder>:/pgdata -e PGDATA=/pgdata \
-d --name timescaledb -p 5432:5432 -e POSTGRES_PASSWORD=password timescale/timescaledb:latest-pg17
-d --name timescaledb -p 5432:5432 -e POSTGRES_PASSWORD=password timescale/timescaledb:latest-pg18
```

If you are running multiple container instances, change the port each Docker instance runs on.

<Highlight type="note">
If you have a local $PG instance already running on port 5432, change the Docker port mapping to avoid conflicts. For example, use `-p 5433:5432` and adjust the connection string accordingly.
</Highlight>

On UNIX-based systems, Docker modifies Linux IP tables to bind the container. If your system uses Linux Uncomplicated Firewall (UFW), Docker may [override your UFW port binding settings][override-binding]. To prevent this, add `DOCKER_OPTS="--iptables=false"` to `/etc/default/docker`.

1. **Connect to a database on your $PG instance**

The default user and database are both `postgres`. You set the password in `POSTGRES_PASSWORD` in the previous step. The default command to connect to $PG in this image is:

```bash
psql -d "postgres://postgres:password@localhost/postgres"
psql -d "postgres://postgres:password@127.0.0.1:5432/postgres"
```

If you changed the port mapping in step 2 (e.g., to 5433), update the port in the connection string accordingly.

1. **Check that $TIMESCALE_DB is installed**

```sql
Expand All @@ -139,10 +151,11 @@ information, see the [Docker documentation on logs][docker-logs].
You see the list of installed extensions:

```sql
Name | Version | Schema | Description
---------------------+---------+------------+---------------------------------------------------------------------------------------
plpgsql | 1.0 | pg_catalog | PL/pgSQL procedural language
timescaledb | 2.20.3 | public | Enables scalable inserts and complex queries for time-series data (Community Edition)
List of installed extensionsh
Name | Version | Default version | Schema | Description
-------------+---------+-----------------+------------+---------------------------------------------------------------------------------------
plpgsql | 1.0 | 1.0 | pg_catalog | PL/pgSQL procedural language
timescaledb | 2.24.0 | 2.24.0 | public | Enables scalable inserts and complex queries for time-series data (Community Edition)
```

Press `q` to exit the list of extensions.
Expand All @@ -155,7 +168,7 @@ outside world, you can bind to `127.0.0.1` instead of the public interface, usin
```bash
docker run -v </a/local/data/folder>:/pgdata -e PGDATA=/pgdata \
-d --name timescaledb -p 127.0.0.1:5432:5432 \
-e POSTGRES_PASSWORD=password timescale/timescaledb:latest-pg17
-e POSTGRES_PASSWORD=password timescale/timescaledb:latest-pg18
```

If you don't want to install `psql` and other $PG client tools locally,
Expand All @@ -179,7 +192,7 @@ data volume using the `-v` flag:
```bash
docker run -d --name timescaledb -p 5432:5432 \
-v </your/data/dir>:/pgdata -e PGDATA=/pgdata \
-e POSTGRES_PASSWORD=password timescale/timescaledb:latest-pg17
-e POSTGRES_PASSWORD=password timescale/timescaledb:latest-pg18
```

When you install $TIMESCALE_DB using a Docker container, the $PG settings
Expand Down
63 changes: 40 additions & 23 deletions _partials/_install-self-hosted-homebrew-based.mdx
Original file line number Diff line number Diff line change
@@ -1,65 +1,82 @@
<Procedure>

1. Install Homebrew, if you don't already have it:
1. **Install Homebrew**

If homebrew is not already installed on your machine, run the following command:
```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

For more information about Homebrew, including installation instructions,
see the [Homebrew documentation][homebrew].
1. At the command prompt, add the $TIMESCALE_DB Homebrew tap:

1. **Install and start $PG**

```bash
brew tap timescale/tap
brew install postgresql@17
brew cleanup --prune-prefix
brew services start postgresql@17
```

1. Install $TIMESCALE_DB and psql:
1. **Add $PG to your path**

```bash
brew install timescaledb libpq
echo 'export PATH="/opt/homebrew/opt/postgresql@17/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc
```

1. Update your path to include psql.
1. **Add the $TIMESCALE_DB Homebrew tap**

```bash
brew link --force libpq
brew tap timescale/tap
```

On Intel chips, the symbolic link is added to `/usr/local/bin`. On Apple
Silicon, the symbolic link is added to `/opt/homebrew/bin`.
1. **Install $TIMESCALE_DB**

1. Run the `timescaledb-tune` script to configure your database:
```bash
brew install timescaledb
```

1. **Configure your database**

```bash
timescaledb-tune --quiet --yes
```

1. Change to the directory where the setup script is located. It is typically,
located at `/opt/homebrew/Cellar/timescaledb/<VERSION>/bin/`, where
`<VERSION>` is the version of `timescaledb` that you installed:
1. **Run the setup script to complete installation**

```bash
cd /opt/homebrew/Cellar/timescaledb/<VERSION>/bin/
```
```bash
$(brew --prefix)/Cellar/timescaledb/$(brew list --versions timescaledb | awk '{print $2}')/bin/timescaledb_move.sh
```

This command automatically locates the correct version and runs the setup script.

1. **Start the $PG service**

```bash
brew services restart postgresql@17
```

1. Run the setup script to complete installation.
1. **Verify $PG is running**

```bash
./timescaledb_move.sh
brew services list | grep postgresql
```

1. **Log in to $PG as `postgres`**
You should see `postgresql@17` with status `started`.

1. **Connect to $PG**

```bash
sudo -u postgres psql
psql postgres
```
You are in the psql shell.

1. **Set the password for `postgres`**
You are now in the psql shell.

1. **Set the password for your database user** (optional but recommended)

```bash
\password postgres
\password
```

When you have set the password, type `\q` to exit psql.
Expand Down
10 changes: 5 additions & 5 deletions _partials/_install-self-hosted-redhat-based.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
To avoid errors, **do not** install $TDB_APACHE and $TDB_COMMUNITY at the same time.

```bash
sudo yum install timescaledb-2-postgresql-17 postgresql17
sudo yum install timescaledb-2-postgresql-18 postgresql18
```

<!-- hack until we have bandwidth to rewrite this linting rule -->
Expand All @@ -94,13 +94,13 @@
1. **Initialize the $PG instance**

```bash
sudo /usr/pgsql-17/bin/postgresql-17-setup initdb
sudo /usr/pgsql-18/bin/postgresql-18-setup initdb
```

1. **Tune your $PG instance for TimescaleDB**

```bash
sudo timescaledb-tune --pg-config=/usr/pgsql-17/bin/pg_config
sudo timescaledb-tune --pg-config=/usr/pgsql-18/bin/pg_config
```

This script is included with the `timescaledb-tools` package when you install TimescaleDB.
Expand All @@ -109,8 +109,8 @@
1. **Enable and start $PG**

```bash
sudo systemctl enable postgresql-17
sudo systemctl start postgresql-17
sudo systemctl enable postgresql-18
sudo systemctl start postgresql-18
```

1. **Log in to $PG as `postgres`**
Expand Down
10 changes: 5 additions & 5 deletions _partials/_install-self-hosted-redhat-rocky.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@
To avoid errors, **do not** install $TDB_APACHE and $TDB_COMMUNITY at the same time.

```bash
sudo dnf install -y postgresql16-server postgresql16-contrib timescaledb-2-postgresql-16
sudo dnf install -y postgresql18-server postgresql18-contrib timescaledb-2-postgresql-18
```

1. **Initialize the $PG instance**

```bash
sudo /usr/pgsql-16/bin/postgresql-16-setup initdb
sudo /usr/pgsql-18/bin/postgresql-18-setup initdb
```

1. **Tune your $PG instance for TimescaleDB**

```bash
sudo timescaledb-tune --pg-config=/usr/pgsql-16/bin/pg_config
sudo timescaledb-tune --pg-config=/usr/pgsql-18/bin/pg_config
```

This script is included with the `timescaledb-tools` package when you install TimescaleDB.
Expand All @@ -25,8 +25,8 @@
1. **Enable and start $PG**

```bash
sudo systemctl enable postgresql-16
sudo systemctl start postgresql-16
sudo systemctl enable postgresql-18
sudo systemctl start postgresql-18
```

1. **Log in to $PG as `postgres`**
Expand Down
10 changes: 5 additions & 5 deletions _partials/_install-self-hosted-redhat-x-platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
To avoid errors, **do not** install $TDB_APACHE and $TDB_COMMUNITY at the same time.

```bash
sudo yum install timescaledb-2-postgresql-17 postgresql17
sudo yum install timescaledb-2-postgresql-18 postgresql18
```

<!-- hack until we have bandwidth to rewrite this linting rule -->
Expand All @@ -29,13 +29,13 @@
1. **Initialize the $PG instance**

```bash
sudo /usr/pgsql-17/bin/postgresql-17-setup initdb
sudo /usr/pgsql-18/bin/postgresql-18-setup initdb
```

1. **Tune your $PG instance for TimescaleDB**

```bash
sudo timescaledb-tune --pg-config=/usr/pgsql-17/bin/pg_config
sudo timescaledb-tune --pg-config=/usr/pgsql-18/bin/pg_config
```

This script is included with the `timescaledb-tools` package when you install TimescaleDB.
Expand All @@ -44,8 +44,8 @@
1. **Enable and start $PG**

```bash
sudo systemctl enable postgresql-17
sudo systemctl start postgresql-17
sudo systemctl enable postgresql-18
sudo systemctl start postgresql-18
```

1. **Log in to $PG as `postgres`**
Expand Down
Loading