From 1747d0f83a330b0a0ab646fe66d6b24420f351bb Mon Sep 17 00:00:00 2001 From: adeboyedn Date: Mon, 1 Dec 2025 13:12:34 +0100 Subject: [PATCH 1/2] docs: add Northflank deployment guide --- public/assets/northflank.svg | 36 +++++++++ public/llms.txt | 1 + src/routes/guides/deploying-your-app.mdx | 6 ++ .../guides/deployment-options/data.json | 3 +- .../guides/deployment-options/northflank.mdx | 73 +++++++++++++++++++ src/ui/image-links.tsx | 1 + 6 files changed, 119 insertions(+), 1 deletion(-) create mode 100644 public/assets/northflank.svg create mode 100644 src/routes/guides/deployment-options/northflank.mdx diff --git a/public/assets/northflank.svg b/public/assets/northflank.svg new file mode 100644 index 000000000..cde44bbb2 --- /dev/null +++ b/public/assets/northflank.svg @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/public/llms.txt b/public/llms.txt index 59c510b3f..9005076ce 100644 --- a/public/llms.txt +++ b/public/llms.txt @@ -50,6 +50,7 @@ - [Vercel](https://docs.solidjs.com/guides/deployment-options/vercel) - [Stormkit](https://docs.solidjs.com/guides/deployment-options/stormkit) - [Zerops](https://docs.solidjs.com/guides/deployment-options/zerops) +- [Northflank](https://docs.solidjs.com/guides/deployment-options/northflank) - [Environment variables](https://docs.solidjs.com/configuration/environment-variables) - [TypeScript](https://docs.solidjs.com/configuration/typescript) - [createEffect](https://docs.solidjs.com/reference/basic-reactivity/create-effect) diff --git a/src/routes/guides/deploying-your-app.mdx b/src/routes/guides/deploying-your-app.mdx index 1bd269567..39bdbb96d 100644 --- a/src/routes/guides/deploying-your-app.mdx +++ b/src/routes/guides/deploying-your-app.mdx @@ -70,4 +70,10 @@ Are you ready to deploy your Solid application? Follow our guides for different href="/guides/deployment-options/zerops" logo="zerops" /> + + diff --git a/src/routes/guides/deployment-options/data.json b/src/routes/guides/deployment-options/data.json index 2fa78a08d..50cfad34c 100644 --- a/src/routes/guides/deployment-options/data.json +++ b/src/routes/guides/deployment-options/data.json @@ -9,6 +9,7 @@ "railway.mdx", "vercel.mdx", "stormkit.mdx", - "zerops.mdx" + "zerops.mdx", + "northflank.mdx" ] } diff --git a/src/routes/guides/deployment-options/northflank.mdx b/src/routes/guides/deployment-options/northflank.mdx new file mode 100644 index 000000000..36ce87a5e --- /dev/null +++ b/src/routes/guides/deployment-options/northflank.mdx @@ -0,0 +1,73 @@ +--- +title: Northflank +order: 7 +mainNavExclude: true +use_cases: >- + web app deployment, cloud hosting, github deployment, production hosting, + quick deployment +tags: + - northflank + - docker + - deployment + - hosting + - cloud + - github +version: "1.0" +description: >- + Deploy SolidStart apps to Northflank using Docker or Heroku buildpacks. +--- + +[Northflank](https://northflank.com) is a full-stack platform for deploying applications, containers, jobs, and managed databases, complete with built-in CI/CD and automated cloud infrastructure. +For a full overview of available features and deployment methods, you can refer to their [documentation](https://northflank.com/docs). + +## Prerequisites + +Before you begin, create a [Northflank account](https://app.northflank.com/signup) and [link your git provider](https://northflank.com/docs/v1/application/getting-started/link-your-git-account). + +## Step 1: Pick a build method +Northflank supports two deployment options for SolidJS applications: + +- **Dockerfile:** Full control over build/runtime. +- **Buildpack:** Simple Node.js deployment (`"start": "vinxi start"`). + +## Step 2: Create a project +- In your Northflank dashboard, click `Create new` → `Project`. +- Give your project a name (e.g., solidjs-project) and optionally choose a color for easy identification. +- Select your deployment target: Northflank Cloud (managed infrastructure) or Bring Your Own Cloud (connect AWS, GCP, Azure, or on-prem resources). +- Pick a region close to your users to minimize latency. +- Click `Create project` to finalize. + +## Step 3: Deploy your app +In your project, navigate to the `Services` tab in the top menu and click `Create New Service`. Select Combined and name your service, for example, `solid-app`. +For the Repository, link to your app repository. + +![create-service-name](https://assets.northflank.com/Screenshot_2025_12_01_at_12_23_18_5947c7fdae.png) + +**Select Build Option:** + +Choose Dockerfile/Buildpack for deployment. + +![create-service-build](https://assets.northflank.com/Screenshot_2025_12_01_at_12_43_52_ebc40592e8.png) + +**Select compute resources:** + +Choose the compute size that best matches your workload: +- Small plans are fine for lightweight usage. +- Larger plans are recommended for heavy usage. + +> Note: You can adjust resources later, so you can start small and scale as needed. + +![create-service-compute.png](https://assets.northflank.com/Screenshot_2025_12_01_at_12_38_24_8d4c7c12b5.png) + +**Set up a port so your app is accessible:** +- Port: 8080 +- Protocol: HTTP +- Public access: enable this to let people access your app from the internet + +Northflank will automatically generate a secure, unique public URL for your service. + +![create-service-port.png](https://assets.northflank.com/Screenshot_2025_12_01_at_12_42_00_f619f86192.png) + +Click `Create service` to deploy you app. + +Once successful, you’ll see the public URL in the top right corner. e.g.: `p01--solid-app--lppg6t2b6kzf.code.run` \ No newline at end of file diff --git a/src/ui/image-links.tsx b/src/ui/image-links.tsx index d287ce897..b58856209 100644 --- a/src/ui/image-links.tsx +++ b/src/ui/image-links.tsx @@ -14,6 +14,7 @@ export const logos: { [key: string]: { file: string; style?: string } } = { railway: { file: "railway.svg" }, vercel: { file: "vercel.svg" }, zerops: { file: "zerops.svg" }, + northflank: { file: "northflank.svg" }, sass: { file: "sass.svg" }, less: { file: "less.svg" }, cssmodules: { file: "css-modules.svg", style: "invert" }, From ac681dc24350a268f1a440a5fff7eb25d414ef3a Mon Sep 17 00:00:00 2001 From: adeboyedn Date: Mon, 1 Dec 2025 13:25:01 +0100 Subject: [PATCH 2/2] docs: refine Northflank guide to match Solid style --- src/routes/guides/deployment-options/northflank.mdx | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/src/routes/guides/deployment-options/northflank.mdx b/src/routes/guides/deployment-options/northflank.mdx index 36ce87a5e..9896390eb 100644 --- a/src/routes/guides/deployment-options/northflank.mdx +++ b/src/routes/guides/deployment-options/northflank.mdx @@ -28,7 +28,7 @@ Before you begin, create a [Northflank account](https://app.northflank.com/signu Northflank supports two deployment options for SolidJS applications: - **Dockerfile:** Full control over build/runtime. -- **Buildpack:** Simple Node.js deployment (`"start": "vinxi start"`). +- **Buildpack:** Simplified Node.js deployment. Ensure your `package.json` includes a proper `start` script. ## Step 2: Create a project - In your Northflank dashboard, click `Create new` → `Project`. @@ -41,13 +41,13 @@ Northflank supports two deployment options for SolidJS applications: In your project, navigate to the `Services` tab in the top menu and click `Create New Service`. Select Combined and name your service, for example, `solid-app`. For the Repository, link to your app repository. -![create-service-name](https://assets.northflank.com/Screenshot_2025_12_01_at_12_23_18_5947c7fdae.png) +create-service-name **Select Build Option:** Choose Dockerfile/Buildpack for deployment. -![create-service-build](https://assets.northflank.com/Screenshot_2025_12_01_at_12_43_52_ebc40592e8.png) +create-service-build **Select compute resources:** @@ -57,7 +57,8 @@ Choose the compute size that best matches your workload: > Note: You can adjust resources later, so you can start small and scale as needed. -![create-service-compute.png](https://assets.northflank.com/Screenshot_2025_12_01_at_12_38_24_8d4c7c12b5.png) +create-service-compute + **Set up a port so your app is accessible:** - Port: 8080 @@ -66,8 +67,8 @@ Choose the compute size that best matches your workload: Northflank will automatically generate a secure, unique public URL for your service. -![create-service-port.png](https://assets.northflank.com/Screenshot_2025_12_01_at_12_42_00_f619f86192.png) +create-service-port -Click `Create service` to deploy you app. +Click `Create service` to deploy your app. Once successful, you’ll see the public URL in the top right corner. e.g.: `p01--solid-app--lppg6t2b6kzf.code.run` \ No newline at end of file