Skip to content

feat: Added the quickstart homepage #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
12 changes: 0 additions & 12 deletions content/docs/quickstart/_category_.json

This file was deleted.

83 changes: 83 additions & 0 deletions content/docs/quickstart/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
title: Quickstart Guide
---
import { IconChartCohort, IconDirections, IconCloudDataConnection, IconBrandInertia, IconFileTypeSql, IconServerBolt,
IconSchema, IconFileDigitFilled, IconCloudComputing } from '@tabler/icons-react';

Get Parseable up and running in minutes with our recommended Docker setup. This guide will help you quickly deploy Parseable and start ingesting logs.

## Prerequisites

- **Docker**: Docker Engine (version 20.10.0 or later)
- **System Requirements**: Minimum 2 CPU cores and 4GB RAM

## Deploy with Docker

### 1. Start Parseable with Docker run

```bash
docker run -p 8000:8000 \
-p 8001:8001 \
-p 8002:8002 \
-v /tmp/parseable/data:/parseable/data \
-v /tmp/parseable/staging:/parseable/staging \
-e P_FS_DIR=/parseable/data \
-e P_STAGING_DIR=/parseable/staging \
containers.parseable.com/parseable/parseable:latest \
parseable local-store
```

### 2. Access the Parseable UI

Open your browser and navigate to [http://localhost:8000](http://localhost:8000)

Login with the default credentials:
- Username: `admin`
- Password: `admin`

> ⚠️ **Warning**: Remember to change the default credentials in a production environment!

### 3. Send Your First Logs

Once Parseable is running, you can create a log stream and send your first logs:

// TODO: Add Script

### 4. Query your logs

Navigate to the Parseable UI at [http://localhost:8000](http://localhost:8000) and select your `my-first-stream` to view your logs.

## Other Installation Options

While Docker is the quickest way to get started, Parseable supports multiple deployment options:

<Cards>
<Card href="/installation/standalone/k8s" icon={<IconSchema className="text-purple-600" />} title='Kubernetes (Helm)'>
You can use Helm charts on Kubernetes.
</Card>

<Card href="/installation/standalone/linux" icon={<IconFileDigitFilled className="text-purple-600" />} title='Binary'>
You can use the Parseable binary.
</Card>

<Card href="/installation/distributed/k8s-helm" icon={<IconCloudComputing className="text-purple-600" />} title='Distributed'>
We recommend using Parseable distributed mode for production deployments.
</Card>
</Cards>


## Next Steps

<Cards>
<Card href="/key-concepts/data-model" icon={<IconChartCohort className="text-purple-600" />} title='Modelling Data'>
Learn when to create datasets, how to aggregate observability data, use schemas, and manage your data effectively.
</Card>

<Card href="/key-concepts/ingestion" icon={<IconDirections className="text-purple-600" />} title='Ingestion'>
Learn how to ingest, manage and query OpenTelemetry logs, metrics or traces natively. Zero configuration needed.
</Card>

<Card href="/key-concepts/high-availability" icon={<IconServerBolt className="text-purple-600" />} title='High Availability'>
Learn how to set up Parseable for high availability.
</Card>
</Cards>
7 changes: 7 additions & 0 deletions content/docs/quickstart/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"title": "Quickstart",
"pages": [
"docker",
"binary"
]
}