Skip to content

Commit 4195479

Browse files
committed
installation
1 parent 82f9e19 commit 4195479

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Installation
3+
description: Setup the CocoIndex environment in 0-3 min
4+
---
5+
6+
## 🐍 Python and Pip
7+
To follow the steps in this guide, you'll need:
8+
9+
To install Python 3.10 or higher. Python 3.12 is recommended.
10+
To install pip, a Python package installer
11+
12+
13+
## 🌴 Install CocoIndex
14+
```bash
15+
pip install cocoindex
16+
```
17+
18+
## 📦 Install Postgres
19+
20+
You can skip this step if you already have a Postgres database with pgvector extension installed.
21+
22+
If you don't have a Postgres database:
23+
24+
1. Make sure Docker Compose 🐳 is installed: [docs](https://docs.docker.com/compose/install/)
25+
2. Start a Postgres SQL database for cocoindex using our docker compose config:
26+
27+
```bash
28+
docker compose -f <(curl -L https://raw.githubusercontent.com/cocoindex-io/cocoindex/refs/heads/main/dev/postgres.yaml) up -d
29+
```
30+
31+
## 🎉 All set!
32+
33+
You can now start using CocoIndex.
34+

docs/sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ const sidebars: SidebarsConfig = {
99
items: [
1010
'getting_started/overview',
1111
'getting_started/quickstart',
12+
'getting_started/installation',
1213
],
1314
},
1415
{

0 commit comments

Comments
 (0)