diff --git a/content/docs/quickstart/_category_.json b/content/docs/quickstart/_category_.json deleted file mode 100644 index 06e6069..0000000 --- a/content/docs/quickstart/_category_.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "label": "Quickstart", - "collapsible": true, - "collapsed": false, - "position": 4, - "link": { - "type": "generated-index", - "title": "Quickstart Guide", - "description": "Get Parseable up and running in minutes with your preferred deployment method." - }, - "customProps": {} -} diff --git a/content/docs/quickstart/index.mdx b/content/docs/quickstart/index.mdx new file mode 100644 index 0000000..ffe148b --- /dev/null +++ b/content/docs/quickstart/index.mdx @@ -0,0 +1,82 @@ +--- +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` + +### 3. Send Your First Logs + +Once Parseable is running, you can create a dataset using the onboarding wizard. + +![Onboarding](./static/onboarding.png) +![Onboarding Complete](./static/on-complete.png) + +### 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: + + +} title='Kubernetes (Helm)'> +You can use Helm charts on Kubernetes. + + +} title='Binary'> +You can use the Parseable binary. + + +} title='Distributed'> +We recommend using Parseable distributed mode for production deployments. + + + + +## Next Steps + + +} title='Modelling Data'> +Learn when to create datasets, how to aggregate observability data, use schemas, and manage your data effectively. + + +} title='Ingestion'> +Learn how to ingest, manage and query OpenTelemetry logs, metrics or traces natively. Zero configuration needed. + + +} title='High Availability'> +Learn how to set up Parseable for high availability. + + diff --git a/content/docs/quickstart/meta.json b/content/docs/quickstart/meta.json new file mode 100644 index 0000000..3cb7c5f --- /dev/null +++ b/content/docs/quickstart/meta.json @@ -0,0 +1,7 @@ +{ + "title": "Quickstart", + "pages": [ + "docker", + "binary" + ] +} diff --git a/content/docs/quickstart/static/on-complete.png b/content/docs/quickstart/static/on-complete.png new file mode 100644 index 0000000..08e8555 Binary files /dev/null and b/content/docs/quickstart/static/on-complete.png differ diff --git a/content/docs/quickstart/static/onboarding.png b/content/docs/quickstart/static/onboarding.png new file mode 100644 index 0000000..9fb41e1 Binary files /dev/null and b/content/docs/quickstart/static/onboarding.png differ