Skip to content

Commit bddc111

Browse files
authored
Merge pull request #1 from AdeboyeDN/docs/add-northflank-hosting-guide
docs: add Northflank hosting guide
2 parents dd33640 + e45b30d commit bddc111

File tree

3 files changed

+43
-1
lines changed

3 files changed

+43
-1
lines changed

content/docs/guides/hosting.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,12 @@ machine with Umami installed and connects to the database remotely to store and
2020
## App hosting
2121

2222
In this setup, you would have an app hosting provider host the Umami app for you. You would still need a database running elsewhere
23-
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.
23+
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.
2424

2525
- [Vercel](https://vercel.com/)
2626
- [Netlify](https://www.netlify.com/)
2727
- [Render](https://render.com/)
28+
- [Northflank](https://northflank.com/)
2829
- [Railway](https://railway.app/)
2930

3031
For the deployment, the build command is `npm run build` and the publish directory is `.next`.

content/docs/guides/meta.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
"hosting",
1313
"running-on-caprover",
1414
"running-on-digitalocean",
15+
"running-on-northflank",
1516
"running-on-fly-io",
1617
"running-on-forge",
1718
"running-on-heroku",
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Running on Northflank
3+
---
4+
5+
[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.
6+
7+
Northflank provides free and paid hosting plans that let you deploy Umami together with a managed PostgreSQL database, all configured automatically.
8+
9+
## Setup Website and Database
10+
11+
### Northflank Button (Recommended)
12+
13+
[![Deploy on Northflank](https://assets.northflank.com/deploy_to_northflank_smm_36700fb050.svg)](https://northflank.com/stacks/deploy-umami)
14+
15+
Click the button above to deploy your own Umami instance with a managed PostgreSQL addon and all environment variables preconfigured.
16+
17+
Once the stack is deployed, go to your Umami service in the Northflank project dashboard and open the public URL.
18+
19+
You should see the setup screen where you can create your admin account and start using Umami.
20+
21+
## Running on Northflank manually
22+
23+
The one-click deployment is the easiest way to get started, but you can also deploy Umami manually using the template configuration.
24+
25+
1. Create a new project on [Northflank](https://northflank.com).
26+
2. Add a **PostgreSQL addon** to the project.
27+
3. Create a **Deployment service** using the Docker image `umamisoftware/umami:postgresql-latest`.
28+
4. Expose port `3000` publicly.
29+
5. Add the following environment variables and link them to your database:
30+
- `DATABASE_URL` — connection string from the PostgreSQL addon
31+
- `DATABASE_TYPE=postgres`
32+
6. Deploy the service.
33+
34+
Once deployed, open the public URL of your service to finish the Umami setup.
35+
36+
### Notes
37+
38+
- Data is stored in the PostgreSQL addon and persists across deploys.
39+
- You can scale the service or update the image version from the dashboard.
40+
- Read more about [adding a website](https://umami.is/docs/add-a-website) and [collecting data](https://umami.is/docs/collect-data) here.

0 commit comments

Comments
 (0)