> ## Documentation Index
> Fetch the complete documentation index at: https://docs.logfleet.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get your first logs flowing in 5 minutes

## Overview

This guide gets you from zero to seeing logs in 5 minutes:

1. Create an account
2. Get your API key
3. Run the edge agent
4. View logs in the dashboard

<Info>
  Already have an account? Skip to [Step 2](#step-2-create-an-api-key).
</Info>

## Step 1: Create Your Account

<Steps>
  <Step title="Sign Up">
    Go to [app.logfleet.io/register](https://app.logfleet.io/register) and create your account.

    Or use the API:

    ```bash theme={null}
    curl -X POST https://api.logfleet.io/api/v1/auth/register \
      -H "Content-Type: application/json" \
      -d '{
        "organization_name": "My Company",
        "email": "you@example.com",
        "password": "YourSecureP@ss123!",
        "name": "Your Name"
      }'
    ```
  </Step>

  <Step title="Save Your Token">
    After registration, save the JWT token from the response:

    ```bash theme={null}
    export TOKEN="eyJhbGciOiJIUzI1NiIs..."
    ```
  </Step>
</Steps>

## Step 2: Create an API Key

Edge agents authenticate with API keys. Create one in the dashboard or via API:

```bash theme={null}
curl -X POST https://api.logfleet.io/api/v1/api-keys \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "my-edge-agent", "permissions": ["read", "write"]}'
```

<Warning>
  Save the `raw_key` immediately - it's only shown once!
</Warning>

```bash theme={null}
export API_KEY="lf_aBcDeFgHiJkLmNoPqRsTuVwXyZ123456"
```

## Step 3: Run the Edge Agent

Deploy the agent using Docker:

```bash theme={null}
docker run -d \
  --name logfleet-agent \
  -e API_KEY=$API_KEY \
  -e CLOUD_URL=https://api.logfleet.io \
  -e AGENT_NAME="my-first-agent" \
  -p 9880:9880 \
  ghcr.io/sadhiappan/logfleet-agent:latest
```

The agent is now:

* Collecting logs on port `9880` (HTTP JSON input)
* Storing logs locally in Loki
* Connected to LogFleet cloud

## Step 4: Send a Test Log

Send a log to your agent:

```bash theme={null}
curl -X POST http://localhost:9880 \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Hello from LogFleet!",
    "level": "info",
    "service": "quickstart"
  }'
```

## Step 5: View in Dashboard

1. Go to [app.logfleet.io](https://app.logfleet.io)
2. Click on your agent
3. Click "Sample Logs" to fetch recent logs

You should see your test log!

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/halfword/images/dashboard-logs.png" alt="Dashboard showing logs" />
</Frame>

## What's Next?

<CardGroup cols={2}>
  <Card title="Deploy to Production" icon="server" href="/guides/edge-agent-setup">
    Configure the agent for production deployments
  </Card>

  <Card title="Custom Metrics" icon="chart-simple" href="/guides/custom-metrics">
    Extract metrics from your logs at the edge
  </Card>

  <Card title="Log Streaming" icon="signal-stream" href="/guides/log-streaming">
    Stream logs in real-time via WebSocket
  </Card>

  <Card title="API Reference" icon="book" href="/api-reference/overview">
    Explore all available endpoints
  </Card>
</CardGroup>

***

## Local Development

For local testing without cloud connectivity, clone the agent repo:

```bash theme={null}
git clone https://github.com/sadhiappan/logfleet.git
cd logfleet/agent
docker compose -f deploy/compose/docker-compose.core.yml up -d
```

This starts:

* **Vector** on port `9881` (log collector)
* **Loki** on port `3101` (log storage)
* **Control Plane** on port `8081` (management API)

See the [Edge Agent Setup Guide](/guides/edge-agent-setup) for details.