Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[doc]: add prerequisites in README.md #304

Merged
merged 2 commits into from
Mar 31, 2024
Merged

[doc]: add prerequisites in README.md #304

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99a3f54
add prerequisites in README.md
broccoliSpicy Mar 30, 2024
9e4e926
set MARCH_NATIVE=ON explicitly
broccoliSpicy Mar 30, 2024
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
42 changes: 30 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,8 @@ If you don’t have PostgreSQL already, use Lantern with [Docker](https://hub.do
```bash
docker run --pull=always --rm -p 5432:5432 -e "POSTGRES_USER=$USER" -e "POSTGRES_PASSWORD=postgres" -v ./lantern_data:/var/lib/postgresql/data lanterndata/lantern:latest-pg15
```

Then, you can connect to the database via `postgresql://$USER:postgres@localhost/postgres`.

To install Lantern from source on top of your existing PostgreSQL:

```
git clone --recursive https://github.com/lanterndata/lantern.git
cd lantern
mkdir build
cd build
cmake ..
make install
```

To install Lantern using `homebrew`:

```
Expand All @@ -43,6 +31,36 @@ You can also install Lantern on top of PostgreSQL from our [precompiled binaries

Alternatively, you can use Lantern in one click using [Replit](https://replit.com/@lanterndata/lantern-playground#.replit).


## 🔧 Build Lantern from source code on top of your existing PostgreSQL
Prerequisites:
```
cmake version: >=3.3
gcc && g++ version: >=11 when building portable binaries, >= 12 when building on new hardware or with CPU-specific vectorization
PostgreSQL 11, 12, 13, 14, 15 or 16
Corresponding development package for PostgreSQL (postgresql-server-dev-$version)

```
To build Lantern on new hardware or with CPU-specific vectorization:
```
git clone --recursive https://github.com/lanterndata/lantern.git
cd lantern
mkdir build
cd build
cmake -DMARCH_NATIVE=ON ..
make install
```

To build portable Lantern binaries:
```
git clone --recursive https://github.com/lanterndata/lantern.git
cd lantern
mkdir build
cd build
cmake -DMARCH_NATIVE=OFF ..
make install
```

## 📖 How to use Lantern

Lantern retains the standard PostgreSQL interface, so it is compatible with all of your favorite tools in the PostgreSQL ecosystem.
Expand Down
Loading