adutra commented on code in PR #2267: URL: https://github.com/apache/polaris/pull/2267#discussion_r2256657870
########## getting-started/getting-started-binary.md: ########## @@ -0,0 +1,119 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# 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 +``` + +- Basic familiarity with running commands in your operating system terminal. + +--- + +## 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 +apache-polaris-<version>-bin.tar.gz +``` + +--- + +## Step 2: Extract the Archive + +Extract the downloaded tar.gz file to your desired directory: + +```bash +tar -xzvf apache-polaris-<version>-bin.tar.gz +cd apache-polaris-<version> +``` + +*Replace `<version>` with the actual version number.* + +--- + +## Step 3: Configure Polaris (Optional) + +Edit the configuration file if needed: Review Comment: Missing a small example here? ########## getting-started/getting-started-binary.md: ########## @@ -0,0 +1,119 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# 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 +``` + +- Basic familiarity with running commands in your operating system terminal. + +--- + +## 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 +apache-polaris-<version>-bin.tar.gz +``` + +--- + +## Step 2: Extract the Archive + +Extract the downloaded tar.gz file to your desired directory: + +```bash +tar -xzvf apache-polaris-<version>-bin.tar.gz +cd apache-polaris-<version> +``` + +*Replace `<version>` with the actual version number.* + +--- + +## Step 3: Configure Polaris (Optional) + +Edit the configuration file if 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: Review Comment: Not sure a browser is the best option, Polaris doesn't have a web UI (yet). Maybe `curl`? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@polaris.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
