Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 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/install-dependencies/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.
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.

## Building and Running

Expand Down
114 changes: 114 additions & 0 deletions site/content/in-dev/unreleased/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,117 @@ weight: 101
build:
render: never
---

# Getting Started with Apache Polaris Binary Distribution
Comment thread
Subham-KRLX marked this conversation as resolved.
Outdated

Quickly start Apache Polaris by running the pre-built binary, no build needed.

---

## Prerequisites

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

```bash
java -version
```

- Basic familiarity with running commands in your operating system terminal.
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.

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
apache-polaris-<version>-bin.tar.gz
Comment thread
Subham-KRLX marked this conversation as resolved.
Outdated
```

---

## 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
tar -xzvf apache-polaris-<version>-bin.tar.gz
cd apache-polaris-<version>
```

*Replace `<version>` with the actual version number.*
Comment thread
Subham-KRLX marked this conversation as resolved.
Outdated

---

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

Start the Polaris server using the provided script:

```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 for details.
Comment thread
Subham-KRLX marked this conversation as resolved.
Outdated
- Use ./bin/polaris-admin in the binary for admin and maintenance tasks.

---

Get started with Apache Polaris binaries. See repo for containers and more.
Comment thread
Subham-KRLX marked this conversation as resolved.
Outdated

---

*Happy data cataloging with Apache Polaris!*

---
Comment thread
Subham-KRLX marked this conversation as resolved.
Outdated

**Want to build or run Polaris from source?**
See the [Quickstart guide](https://polaris.apache.org/in-dev/unreleased/getting-started/quickstart/) for developer instructions and advanced setup.
Comment thread
Subham-KRLX marked this conversation as resolved.
Outdated

---
Loading