Skip to content

Commit 7d338b6

Browse files
committed
readme for deb
1 parent 9b1e885 commit 7d338b6

File tree

1 file changed

+47
-2
lines changed

1 file changed

+47
-2
lines changed

packaging/README.md

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# To Build Your Own Debian Packages With Docker
1+
# 🛠️ To Build Your Own Debian Packages With Docker
22

33
Run `./packaging/build_packages.sh -h` and follow the instructions.
44
E.g. to build for Debian 12 and PostgreSQL 16, run:
@@ -9,4 +9,49 @@ E.g. to build for Debian 12 and PostgreSQL 16, run:
99

1010
Packages can be found at the `packages` directory by default, but it can be configured with the `--output-dir` option.
1111

12-
**Note:** The packages do not include pg_documentdb_distributed in the `internal` directory.
12+
**Note:** The packages do not include pg_documentdb_distributed in the `internal` directory.
13+
14+
# 📦 Installing DocumentDB from `.deb` Packages
15+
16+
We provide prebuilt `.deb` packages for PostgreSQL versions **15**, **16**, and **17** on the following operating systems:
17+
18+
- **Debian 11** (bullseye)
19+
- **Debian 12** (bookworm)
20+
- **Ubuntu 22.04** (jammy)
21+
- **Ubuntu 24.04** (noble)
22+
23+
## 🔽 1. Download the Package
24+
25+
Visit the [Releases](../../releases) page of this repository and download the `.deb` package that matches your OS and PostgreSQL version.
26+
27+
Example:
28+
29+
```bash
30+
wget https://github.com/YOUR_ORG/YOUR_REPO/releases/download/v0.103.0/deb12-postgresql-16-documentdb_0.103.0_amd64.deb
31+
```
32+
33+
## 🔽 2. Install the Package
34+
35+
Install the downloaded package using `dpkg`:
36+
```bash
37+
sudo dpkg -i deb12-postgresql-16-documentdb_0.103.0_amd64.deb
38+
```
39+
If you see dependency errors, fix them with:
40+
```bash
41+
sudo apt-get install -f
42+
```
43+
44+
## 🔽 3. Enable the Extension in PostgreSQL
45+
46+
After installing the package, enable the extension in your PostgreSQL database:
47+
```sql
48+
CREATE EXTENSION documentdb;
49+
```
50+
Make sure you connect to the correct PostgreSQL instance that matches the installed version.
51+
52+
## 🔽 4. Verify Installation
53+
Run the following query to verify that the extension is available:
54+
55+
```sql
56+
SELECT * FROM pg_available_extensions WHERE name = 'documentdb';
57+
```

0 commit comments

Comments
 (0)