Skip to content
Merged
Show file tree
Hide file tree
Changes from 8 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
109 changes: 100 additions & 9 deletions site/content/in-dev/unreleased/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,110 @@ type: docs
weight: 101
---

There are several options for getting started with Apache Polaris.
# Getting Started with Apache Polaris Binary Distribution
Comment thread
Subham-KRLX marked this conversation as resolved.
Outdated

To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
Quickly start Apache Polaris by running the pre-built binary, no build needed.

## Docker Compose Examples
Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
---

## Prerequisites

- Java 21 or later installed. You can verify this by running:

```bash
java -version
```

---

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.

Nit: the separator may not be quite helpful for a small section like this. Could we remove all of them?


## Step 1: Download the Apache Polaris Binary

1. Visit the official Apache Polaris GitHub
[Releases page](https://github.com/apache/polaris/releases).
Comment thread
Subham-KRLX marked this conversation as resolved.
Outdated

2. Download the latest binary archive file, for example:

```bash
curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz
```

---

## Step 2: Extract the Archive

Extract the downloaded tar.gz file to your desired directory:
Comment thread
Subham-KRLX marked this conversation as resolved.
Outdated

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.

please remove this step as step 1 extract it already.


```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

```

---

## Step 3: Configure Polaris (Optional)

Edit the `application.properties` file if needed. For example:
Comment thread
Subham-KRLX marked this conversation as resolved.
Outdated

```bash
polaris.storage.backend=local
polaris.storage.local.path=/data/polaris
```

*(This is a configuration file, not a shell command. Adjust these values as needed.)*

---

## Step 4: Run the Polaris Server

### Next Steps
Start the Polaris server using the provided script:

1. Check & install dependencies
2. Choose the way you want to deploy Polaris
3. Create a catalog
4. Check Using Polaris page
```bash
./bin/polaris-server.sh start
Comment thread
Subham-KRLX marked this conversation as resolved.
Outdated
```

To tail the logs in a separate terminal, run:

```bash
tail -f logs/polaris.log
```

---

## Step 5: Verify the Server is Running

Open your browser and navigate to:

```bash
curl http://localhost:8181/api/catalog/v1/health

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.

I think the path is wrong.

```

You should see the Polaris server running or be able to access its REST API.

---

## Step 6: Stop the Polaris Server

To stop the server, run:

```bash
./bin/polaris-server.sh stop
Comment thread
Subham-KRLX marked this conversation as resolved.
Outdated
```

---

## Additional Resources

- See the [official Apache Polaris documentation](https://polaris.apache.org/docs/) for comprehensive information on configuration, deployment, and usage.

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 may not need to mention it, as people visiting this page are already here.

- Use `./bin/polaris-admin` in the binary distribution for administrative and maintenance tasks.

---

## Other Getting Started Options

For building and running Polaris from source code, check out the [Quickstart guide](./quick-start/).

For Docker Compose examples and other deployment options, please see the [documentation](https://polaris.apache.org).

---

### Getting Help

Expand Down