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

# Introduction

> Welcome to your project

Zepeed is a self-hosted internet speed monitoring platform built on modern web technologies. Schedule automated speedtests from multiple providers, track network performance over time, and receive real-time notifications—all from your own infrastructure.

## What you can do with Zepeed

**Monitor your network**: Run speedtests using Speedtest Ookla, LibreSpeed, Cloudflare, or Fast.com. Get download speeds, upload speeds, and latency measurements in a unified dashboard.

**Automate testing**: Schedule speedtests to run at intervals you define. Zepeed runs them automatically and stores historical data for analysis.

**Track performance**: View performance metrics over time. Identify trends, detect degradation, and troubleshoot ISP issues with historical data.

**Get notified**: Receive real-time alerts when tests complete, fail, or meet your configured thresholds via webhooks or email.

**Maintain control**: Define maintenance windows to pause tests during maintenance periods. Use the API to integrate with your own systems.

## Built for...

**Network administrators** managing multiple locations or ISP connections who need reliable performance monitoring without reliance on external SaaS.

**Homelab enthusiasts** wanting to track their home internet performance and receive alerts when speeds degrade.

**Organizations** with specific compliance or data residency requirements that mandate on-premises solutions.

**Developers** integrating speedtest data into dashboards, alerting systems, or infrastructure automation.

## How it works

Zepeed acts as an orchestrator. You configure speedtest providers, define test schedules, and choose notification methods. Zepeed handles the rest:

1. Executes tests on your schedule using the providers you select
2. Stores results with timestamps and metadata
3. Sends notifications to webhooks or email addresses
4. Exposes data via REST API for custom integrations
5. Displays results in a web dashboard

All data stays within your infrastructure.

## Technology stack

| Component          | Technology                             |
| ------------------ | -------------------------------------- |
| Backend            | Laravel 13 with Fortify authentication |
| Frontend           | Vue 3 with shadcn/vue components       |
| Styling            | Tailwind CSS v4                        |
| Build tooling      | Vite, TypeScript, ESLint, Prettier     |
| Testing            | PHPUnit, PHPStan                       |
| Containerization   | Docker                                 |
| Package management | Composer, Bun                          |

## Complete feature list

Zepeed includes comprehensive features for speedtest aggregation, monitoring, and integration:

* **Multiple speedtest providers** — Combine results from Speedtest Ookla, LibreSpeed, Cloudflare, and [Fast.com](http://Fast.com)
* **Scheduled automation** — Run tests on your schedule with customizable intervals
* **Manual execution** — Trigger tests immediately from the dashboard
* **Real-time notifications** — Get alerted on test completion via webhooks or email
* **Maintenance windows** — Pause tests during scheduled maintenance
* **Customizable templates** — Create test configurations for different scenarios
* **Email delivery** — Send results via SMTP, Mailgun, Postmark, AWS SES, and more
* **Ping testing** — Monitor latency independent of full speedtests
* **REST API** — Full access to test data and configuration management
* **Webhook integration** — Send results to any HTTP endpoint
* **Performance dashboard** — View speeds, history, and trends at a glance
* **User management** — Control access with role-based permissions
* **Docker deployment** — Deploy with Docker Compose
* **Open source** — MIT licensed with source on GitHub

For a complete breakdown of all features organized by category, see the [Features](/features) page.

## Getting started

<CardGroup cols={2}>
  <Card title="Features" icon="star" href="/features">
    Explore all Zepeed capabilities
  </Card>

  <Card title="Installation" icon="download" href="/getting-started/installation">
    Deploy Zepeed locally or in the cloud
  </Card>

  <Card title="Quick setup" icon="rocket" href="/getting-started/quickstart">
    Configure your first speedtest in minutes
  </Card>

  <Card title="Configuration" icon="sliders" href="/configuration/overview">
    Customize providers, schedules, and notifications
  </Card>
</CardGroup>

## Status and stability

<Warning>
  Zepeed is under active development. Features, APIs, configuration options, and internal behavior may change without notice. Breaking changes can occur between releases.

  If you depend on this project in production, consider pinning to a specific version and reviewing release notes before upgrading.
</Warning>

## Next steps

Choose your path:

* **Just getting started?** Head to the [installation guide](/using-docker-compose)
* **Want to explore capabilities?** Check out the [features page](/features)
* **Need to configure providers?** See [setting up providers](/providers)
* **Building an integration?** Check out the [API documentation](/api/overview)
* **Contributing?** Read the [contribution guidelines](/contributing/overview)

## Questions or feedback?

* Report issues on [GitHub](https://github.com/MarJose123/zepeed/issues)
* Check [discussions](https://github.com/MarJose123/zepeed/discussions) for community questions
* Submit pull requests for improvements