Skip to content
Merged
Show file tree
Hide file tree
Changes from 11 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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ for contribution guidelines.
Click [here](https://polaris.apache.org/in-dev/unreleased/) for a quick overview of Polaris.

## Quickstart
Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/quick-start/) for the quickstart experience.
Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.
Comment thread
Subham-KRLX marked this conversation as resolved.

## Project Structure

Expand Down
87 changes: 74 additions & 13 deletions site/content/in-dev/unreleased/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,83 @@ type: docs
weight: 101
---

There are several options for getting started with Apache Polaris.
This guide will help you get started with Apache Polaris using the binary distribution, which is the fastest way to set up a Polaris server.

To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
## Prerequisites

## Docker Compose Examples
Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
Before you begin, ensure you have the following:

### Next Steps
- Java SE 21 or higher installed
- Verify Java installation:

1. Check & install dependencies
2. Choose the way you want to deploy Polaris
3. Create a catalog
4. Check Using Polaris page
```bash
java -version
```

### Getting Help
## Step 1: Download and Extract the Binary Distribution

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have this (based on tar) and https://polaris.apache.org/in-dev/unreleased/getting-started/quick-start/ (based on docker). Would it make sense to move this section into a sub-page parallel to the docker-compose example?


- Documentation: https://polaris.apache.org
- GitHub Issues: https://github.com/apache/polaris/issues
- Slack: [Join Apache Polaris Community](https://join.slack.com/t/apache-polaris/shared_invite/zt-2y3l3r0fr-VtoW42ltir~nSzCYOrQgfw)
1. Visit the [Apache Polaris downloads page](https://polaris.apache.org/downloads/).

2. Download the latest binary distribution (tar.gz file) and extract it to your desired directory:

```bash
tar -xzf apache-polaris-1.0.0-incubating-bin.tar.gz
```

## Step 2: Configure Polaris

Navigate to the extracted directory:

```bash
cd apache-polaris-1.0.0-incubating-bin

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we could move this to next step configure Polaris

```

Configure Polaris using environment variables or system properties. For example:

```bash
export POLARIS_JAVA_OPTS="-Dquarkus.http.port=8080"
export POLARIS_JAVA_OPTS="-Dpolaris.persistence.type=relational-jdbc"
export POLARIS_JAVA_OPTS="-Xms512m -Xmx1g -Dquarkus.http.port=8080"
Comment thread
dimas-b marked this conversation as resolved.
Outdated
```

## Step 3: Start Polaris Server

Start the Polaris server:

```bash
bin/server
```

You should see output indicating that Polaris is starting up. When ready, you'll see messages similar to:

```
INFO [io.quarkus] Apache Polaris Server (incubating) started in X.XXXs. Listening on: http://0.0.0.0:8181. Management interface listening on http://0.0.0.0:8182.
```

## Step 4: Verify the Installation

Verify that Polaris is running by checking the health endpoint:

```bash
curl http://localhost:8182/q/health
```

You should receive a response indicating the server is healthy.

## Step 5: Stop Polaris Server

To stop the Polaris server, press `Ctrl+C` in the terminal where it's running.

## Admin Tool

The binary distribution includes an admin tool for administrative and maintenance tasks:

```bash
bin/admin --help
bin/admin bootstrap -h
bin/admin purge -h
```

## Next Steps

For instructions on building and running Polaris from source code, see the [Quickstart]({{% relref "quickstart" %}}) guide.