<h1>Running on PlanetScale</h1>
<p><a href="https://planetscale.com/">PlanetScale</a> is a MySQL-compatible serverless database platform. PlanetScale uses <a href="https://vitess.io/">Vitess</a> which doesn't support foreign keys and therefore we have to modify <code>schema.mysql.sql</code> as explained below.</p>
<h2>Setup</h2>
<ol>
<li>Fork the <a href="https://github.com/umami-software/umami">https://github.com/umami-software/umami</a> project to your GitHub account.</li>
<li>Create a database on PlanetScale called <code>umami-db</code> and get its connection string (Hint: select "Prisma" from the "Connect with" menu). It should look something like this: <code>mysql://username:password@host/umami-db?sslaccept=strict</code></li>
<li>Add <code>DATABASE_URL</code> and <code>HASH_SALT</code> (any random string) to you <code>.env</code> file:</li>
</ol>
<pre><code>DATABASE_URL=mysql://username:password@host/umami-db?sslaccept=strict
HASH_SALT=any-random-string
</code></pre>
<ol start="4">
<li>Open <code>schema.mysql.sql</code> and delete all lines after <code>-- AddForeignKey</code>. See example below.</li>
</ol>
<pre><code>-- AddForeignKey
ALTER TABLE `event` ADD CONSTRAINT `event_ibfk_2` FOREIGN KEY (`session_id`) REFERENCES `session`(`session_id`) ON DELETE CASCADE ON UPDATE NO ACTION;

-- AddForeignKey
ALTER TABLE `event` ADD CONSTRAINT `event_ibfk_1` FOREIGN KEY (`website_id`) REFERENCES `website`(`website_id`) ON DELETE CASCADE ON UPDATE NO ACTION;

-- AddForeignKey
ALTER TABLE `pageview` ADD CONSTRAINT `pageview_ibfk_2` FOREIGN KEY (`session_id`) REFERENCES `session`(`session_id`) ON DELETE CASCADE ON UPDATE NO ACTION;

-- AddForeignKey
ALTER TABLE `pageview` ADD CONSTRAINT `pageview_ibfk_1` FOREIGN KEY (`website_id`) REFERENCES `website`(`website_id`) ON DELETE CASCADE ON UPDATE NO ACTION;

-- AddForeignKey
ALTER TABLE `session` ADD CONSTRAINT `session_ibfk_1` FOREIGN KEY (`website_id`) REFERENCES `website`(`website_id`) ON DELETE CASCADE ON UPDATE NO ACTION;

-- AddForeignKey
ALTER TABLE `website` ADD CONSTRAINT `website_ibfk_1` FOREIGN KEY (`user_id`) REFERENCES `account`(`user_id`) ON DELETE CASCADE ON UPDATE NO ACTION;
</code></pre>
<ol start="5">
<li>Download the <a href="https://github.com/planetscale/cli/releases">PlanetScale CLI</a> and authenticate with <code>pscale auth login</code>.</li>
<li>Create the tables by running the following command on the root of the project: <code>pscale shell umami-db main &#x26;lt; sql/schema.mysql.sql</code>.</li>
<li>You should now be able to build and start Umami (<code>npm run build</code> followed by <code>npm start</code>).</li>
<li>Follow the <strong>Getting started</strong> guide starting from the <a href="/docs/login">Login</a> step and be sure to change the default password.</li>
</ol>
<h3>Troubleshooting</h3>
<p>If are getting an error like the following example:</p>
<pre><code>PrismaClientInitializationError: Can't reach database server at `host.aws-region.psdb.cloud`:`3306`
</code></pre>
<p>You can try add a connection timeout query parameter on your <code>DATABASE_URL</code>:</p>
<pre><code>DATABASE_URL=mysql://username:password@host/umami-db?sslaccept=strict&#x26;connect_timeout=300
</code></pre>


Documentation

Basics

Advanced

Guides