Quick start
The dashboard waits for the first pageview and then opens by itself.
- Upload. Download the release zip, upload it to your host and unzip it. Point the domain's document root at the
public/folder. - Run the installer. Visit
https://your-domain/install. It checks the server, connects your database (SQLite needs no setup), runs the migrations and creates your admin account. - Add a site. Enter the domain you want to measure. Tidemark shows a snippet for it.
- Paste the snippet into your site's
<head>:
<script defer data-domain="example.com" src="https://stats.example.com/js/script.js"></script>
The dashboard waits for the first pageview and then opens by itself.
Optional: add a cron job if you want queued ingestion or automatic data retention. Neither is needed to get started.
Try it with demo data#
Running locally rather than on a host? Generate fake traffic first:
composer install && cp .env.example .env && php artisan key:generate
touch database/database.sqlite && php artisan migrate
php artisan tidemark:demo # [email protected] / password
php artisan serve