diff --git a/README.md b/README.md index 1296e00cb..ad082daaa 100644 --- a/README.md +++ b/README.md @@ -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. ## Building and Running diff --git a/site/content/in-dev/unreleased/getting-started/_index.md b/site/content/in-dev/unreleased/getting-started/_index.md index ee0f9b687..a97bb34c5 100644 --- a/site/content/in-dev/unreleased/getting-started/_index.md +++ b/site/content/in-dev/unreleased/getting-started/_index.md @@ -23,3 +23,101 @@ weight: 101 build: render: never --- + +# Getting Started with Apache Polaris Binary Distribution + +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 +``` + +--- + +## Step 1: Download the Apache Polaris Binary + +1. Visit the official Apache Polaris GitHub + [Releases page](https://github.com/apache/polaris/releases). + +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: + +```bash +cd apache-polaris-1.0.0-incubating-bin +``` + +--- + +## Step 3: Configure Polaris (Optional) + +Edit the `application.properties` file if needed. For example: + +```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 +``` + +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 +``` + +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 +``` + +--- + +## Additional Resources + +- See the [official Apache Polaris documentation](https://polaris.apache.org/docs/) for comprehensive information on configuration, deployment, and usage. +- Use `./bin/polaris-admin` in the binary distribution for administrative and maintenance tasks. + +--- + +Get started with Apache Polaris binaries. See the [repository](https://github.com/apache/polaris) for container images and more resources, or check out the [Quickstart guide](https://polaris.apache.org/in-dev/unreleased/getting-started/quickstart/) for developer instructions and advanced setup. + +---