diff --git a/content/docs/guides/hosting.mdx b/content/docs/guides/hosting.mdx index b00c80e..d03a945 100644 --- a/content/docs/guides/hosting.mdx +++ b/content/docs/guides/hosting.mdx @@ -20,11 +20,12 @@ machine with Umami installed and connects to the database remotely to store and ## App hosting In this setup, you would have an app hosting provider host the Umami app for you. You would still need a database running elsewhere -that the app could connect to. Here are a few app hosting providers that can host Umami. Vercel, Netlify, and Render have a free tier available. +that the app could connect to. Here are a few app hosting providers that can host Umami. Vercel, Netlify, Render, and Northflank have a free tier available. - [Vercel](https://vercel.com/) - [Netlify](https://www.netlify.com/) - [Render](https://render.com/) +- [Northflank](https://northflank.com/) - [Railway](https://railway.app/) For the deployment, the build command is `npm run build` and the publish directory is `.next`. diff --git a/content/docs/guides/meta.json b/content/docs/guides/meta.json index 00aa240..7114755 100644 --- a/content/docs/guides/meta.json +++ b/content/docs/guides/meta.json @@ -12,6 +12,7 @@ "hosting", "running-on-caprover", "running-on-digitalocean", + "running-on-northflank", "running-on-fly-io", "running-on-forge", "running-on-heroku", diff --git a/content/docs/guides/running-on-northflank.mdx b/content/docs/guides/running-on-northflank.mdx new file mode 100644 index 0000000..28d9b4d --- /dev/null +++ b/content/docs/guides/running-on-northflank.mdx @@ -0,0 +1,40 @@ +--- +title: Running on Northflank +--- + +[Northflank](https://northflank.com) is a fully managed platform for building, deploying, and scaling applications using containers. It combines the flexibility of cloud infrastructure with a simple developer experience so you can focus on your app instead of managing servers. + +Northflank provides free and paid hosting plans that let you deploy Umami together with a managed PostgreSQL database, all configured automatically. + +## Setup Website and Database + +### Northflank Button (Recommended) + +[![Deploy on Northflank](https://assets.northflank.com/deploy_to_northflank_smm_36700fb050.svg)](https://northflank.com/stacks/deploy-umami) + +Click the button above to deploy your own Umami instance with a managed PostgreSQL addon and all environment variables preconfigured. + +Once the stack is deployed, go to your Umami service in the Northflank project dashboard and open the public URL. + +You should see the setup screen where you can create your admin account and start using Umami. + +## Running on Northflank manually + +The one-click deployment is the easiest way to get started, but you can also deploy Umami manually using the template configuration. + +1. Create a new project on [Northflank](https://northflank.com). +2. Add a **PostgreSQL addon** to the project. +3. Create a **Deployment service** using the Docker image `umamisoftware/umami:postgresql-latest`. +4. Expose port `3000` publicly. +5. Add the following environment variables and link them to your database: + - `DATABASE_URL` — connection string from the PostgreSQL addon + - `DATABASE_TYPE=postgres` +6. Deploy the service. + +Once deployed, open the public URL of your service to finish the Umami setup. + +### Notes + +- Data is stored in the PostgreSQL addon and persists across deploys. +- You can scale the service or update the image version from the dashboard. +- Read more about [adding a website](https://umami.is/docs/add-a-website) and [collecting data](https://umami.is/docs/collect-data) here. \ No newline at end of file