Skip to content

Commit 48da122

Browse files
committed
Consolidate binary setup in Getting Started index, update README quickstart link, update quickstart.md and remove redundant binary doc
1 parent 163e595 commit 48da122

File tree

4 files changed

+118
-120
lines changed

4 files changed

+118
-120
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ for contribution guidelines.
4040
Click [here](https://polaris.apache.org/in-dev/unreleased/) for a quick overview of Polaris.
4141

4242
## Quickstart
43-
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.
43+
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.
4444

4545
## Building and Running
4646

getting-started/getting-started-binary.md

Lines changed: 0 additions & 119 deletions
This file was deleted.

site/content/in-dev/unreleased/getting-started/_index.md

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,117 @@ weight: 101
2323
build:
2424
render: never
2525
---
26+
27+
# Getting Started with Apache Polaris Binary Distribution
28+
29+
Quickly start Apache Polaris by running the pre-built binary, no build needed.
30+
31+
---
32+
33+
## Prerequisites
34+
35+
- Java 21 or later installed. You can verify this by running:
36+
37+
```bash
38+
java -version
39+
```
40+
41+
- Basic familiarity with running commands in your operating system terminal.
42+
43+
---
44+
45+
## Step 1: Download the Apache Polaris Binary
46+
47+
1. Visit the official Apache Polaris GitHub
48+
[Releases page](https://github.com/apache/polaris/releases).
49+
50+
2. Download the latest binary archive file, for example:
51+
52+
```bash
53+
apache-polaris-<version>-bin.tar.gz
54+
```
55+
56+
---
57+
58+
## Step 2: Extract the Archive
59+
60+
Extract the downloaded tar.gz file to your desired directory:
61+
62+
```bash
63+
tar -xzvf apache-polaris-<version>-bin.tar.gz
64+
cd apache-polaris-<version>
65+
```
66+
67+
*Replace `<version>` with the actual version number.*
68+
69+
---
70+
71+
## Step 3: Configure Polaris (Optional)
72+
73+
Edit the `application.properties` file if needed. For example:
74+
75+
```bash
76+
polaris.storage.backend=local
77+
polaris.storage.local.path=/data/polaris
78+
```
79+
*(This is a configuration file, not a shell command. Adjust these values as needed.)*
80+
81+
---
82+
83+
## Step 4: Run the Polaris Server
84+
85+
Start the Polaris server using the provided script:
86+
87+
```bash
88+
./bin/polaris-server.sh start
89+
```
90+
91+
To tail the logs in a separate terminal, run:
92+
93+
```bash
94+
tail -f logs/polaris.log
95+
```
96+
97+
---
98+
99+
## Step 5: Verify the Server is Running
100+
101+
Open your browser and navigate to:
102+
103+
```bash
104+
curl http://localhost:8181/api/catalog/v1/health
105+
```
106+
107+
You should see the Polaris server running or be able to access its REST API.
108+
109+
---
110+
111+
## Step 6: Stop the Polaris Server
112+
113+
To stop the server, run:
114+
115+
```bash
116+
./bin/polaris-server.sh stop
117+
```
118+
119+
---
120+
121+
## Additional Resources
122+
123+
- See the official Apache Polaris documentation for details.
124+
- Use ./bin/polaris-admin in the binary for admin and maintenance tasks.
125+
126+
---
127+
128+
Get started with Apache Polaris binaries. See repo for containers and more.
129+
130+
---
131+
132+
*Happy data cataloging with Apache Polaris!*
133+
134+
---
135+
136+
**Want to build or run Polaris from source?**
137+
See the [Quickstart guide](https://polaris.apache.org/in-dev/unreleased/getting-started/quickstart/) for developer instructions and advanced setup.
138+
139+
---

site/content/in-dev/unreleased/getting-started/quickstart.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,3 +114,6 @@ docker run --name trino -d -p 8080:8080 trinodb/trino
114114

115115
## Next Steps
116116
Congrats, you now have a running instance of Polaris! For further information regarding how to use Polaris, check out the [Using Polaris]({{% ref "using-polaris" %}}) page.
117+
118+
119+

0 commit comments

Comments
 (0)