Deploy Next.js on Upsun

Note

Before you start, check out the Upsun demo app and the main Getting started guide. They provide all of the core concepts and common commands you need to know before using the materials below.

Before you begin

You need:

Git. Git is the primary tool to manage everything your app needs to run. Push commits to deploy changes and control configuration through YAML files. These files describe your infrastructure, making it transparent and version-controlled.
A Upsun account. If you don’t already have one, register for a trial account. You can sign up with an email address or an existing GitHub, Bitbucket, or Google account. If you choose one of these accounts, you can set a password for your Upsun account later.
The Upsun CLI. This lets you interact with your project from the command line. You can also do most things through the Web Console.

1. Create a Next.js app

To create your Next.js app, follow these steps.

Follow the Next.js installation guide. To fast track the process, run the following commands:

Terminal
```
npx create-next-app@latest myapp
```
To initialize the local Git repository and commit local files, run the following commands:

Terminal
```
cd myapp
git init
git add .
git commit -m "Init Next.js application."
```

Note

You can view the running app locally by running npm run dev.

2. Create a new project

To create a project on Upsun, follow these steps.

Remember

After creating your Upsun project, copy your new project ID for later use.

Using the CLI
Using the Console

To create a new project with the Upsun CLI, use the following command and follow the prompts:

Terminal

upsun project:create

Note

When creating a new project using the Upsun CLI command project:create, you are asked if you want to set the local remote to your new project. Enter Yes (y).

Your local source code is automatically linked to your newly created Upsun project through the creation of a .upsun/local/project.yaml. This file contains the corresponding <projectId> for the Upsun CLI to use, and sets a Git remote to upsun.

Create an organization or select an existing one.
Click Create from scratch.
Fill in details like the project name and region.

Note

You can define resources for your project later on, after your first push.

To link your local source code to your new Upsun project, run the following command:

Terminal
```
upsun project:set-remote <projectId>
```
This command adds a new remote called upsun to your local Git repository, which is equivalent to the following commands:

Terminal
```
git remote
origin
upsun
```
It also creates a new .upsun/local/project.yaml file that contains the <projectId> for the upsun CLI to use.

Tip

If you forget your <projectId>, run the following command and find your project in the list:

Terminal

upsun project:list

3. Choose your Git workflow

You can use Upsun projects as a classic Git repository, where you are able to push your source code in different ways, using either the Git CLI or the Upsun CLI. You can choose which way —or Git workflow— you want to use for your project from the following options:

Your project source code is hosted on a Upsun Git repository
Your project source code is hosted on your own GitHub repository

Upsun Git repository
GitHub repository

For the rest of this guide, you will use the normal Git workflow (git add . && git commit -m "message" && git push upsun) to commit your source code changes to Git history. You will also use the Upsun CLI to deploy your Upsun environment with the latest code updates.

Upsun provides a Github integration that allows your Upsun project to be fully integrated with your Github repository. This enables you, as a developer, to use a normal Git workflow (git add . && git commit -m "message" && git push) to deploy your environment—with no need to connect to the Upsun Console.

Note

Make sure you complete the following steps before adding a Github integration:

Create a Git repository in your own organization following the relevant Github repository creation guide.
Create a Github integration.
Add a Git remote to your local project, from the root of your Next.js directory.
To do so, run the following commands:

Terminal
```
git remote add origin <urlOfYourOwnGitHubRepo>
git add . && git commit -m "init next.js"
git push origin
```

4. Configure your project

To host your Next.js application on Upsun, you need to have a few YAML configuration files at the root of your project. These files manage your app’s behavior. They are located in a .upsun/ folder at the root of your source code and structured in a similar way to this:

myapp
├── .upsun
│   └── config.yaml
├── [.environment]
└── <project sources>

To generate these files, run the following command at the root of your project:

Terminal

upsun project:init

Follow the prompts, and you should result in such a config file.

.upsun/config.yaml

applications:
  myapp:
    source:
      root: "/"
    type: "nodejs:22"
    mounts:
      "/.npm":
        source: "storage"
        source_path: "npm"
    hooks:
      build: |
        set -eux
        npm i
        npm run build        
    web:
      commands:
        start: "npx next start -p $PORT"
      upstream:
        socket_family: tcp
      locations:
        "/":
          passthru: true
routes:
  "https://{default}/": { type: upstream, upstream: "myapp:http" }
  "http://{default}/": { type: redirect, to: "https://{default}/" }

As an example, above is the minimum configuration needed to deploy a Next.js application on Upsun without any services. Depending on your answers to the prompts, you may also have relationships and services defined.

To commit your new files, run the following commands:

Terminal

git add .
git commit -m "Add Upsun config files"

5. Deploy

And just like that, it’s time to deploy!

Depending on the Git workflow you chose at the beginning of this tutorial, there are two ways to deploy your source code changes.

Using Upsun Git repository
Using third-party Git repository

You can push your code using the normal Git workflow (git add . && git commit -m "message" && git push). This pushes your source code changes to your upsun remote repository. Alternatively, you can use the following Upsun CLI command:

Terminal

upsun push

When you choose to use a third-party Git hosting service, the Upsun Git repository becomes a read-only mirror of the third-party repository. All your changes take place in the third-party repository.

Add an integration to your existing third-party repository:

If you are using an integration, on each code updates, use the normal Git workflow (git add . && git commit -m "message" && git push) to push your code to your external repository. To do so, run the following command:

Terminal

git push origin

Your GitHub, GitLab, or Bibucket integration process then automatically deploys changes to your environment. If you’re pushing a new Git branch, a new environment is created.

Upsun then reads your configuration files, and deploys your project using default container resources. If you don’t want to use those default resources, define your own resource initialization strategy, or amend those default container resources after your project is deployed.

Et voilà, your Next.js application is live!

Tip

Each environment has its own domain name. To open the URL of your new environment, run the following command:

Terminal

upsun environment:url --primary

6. Make changes to your project

Now that your project is deployed, you can start making changes to it. For example, you might want to fix a bug or add a new feature.

In your project, the main branch always represents the production environment. Other branches are for developing new features, fixing bugs, or updating the infrastructure.

To make changes to your project, follow these steps:

Create a new environment (a Git branch) to make changes without impacting production:

Terminal
```
upsun branch feat-a
```
This command creates a new local feat-a Git branch based on the main Git branch, and activates a related environment on Upsun. The new environment inherits the data (service data and assets) of its parent environment (the production environment here).

Make changes to your project. For example, edit the views/index.jade file and make the following changes:

diff --git a/views/index.jade b/views/index.jade
index 3d63b9a..77aee43 100644
--- a/views/index.jade
+++ b/views/index.jade
@@ -2,4 +2,4 @@ extends layout

 block content
   h1= title
-  p Welcome to #{title}
+  p Welcome to #{title} on Upsun
``

Commit your changes:

Terminal

git add views/index.jade
git commit -m "Update index page view."

Deploy your changes to the feat-a environment:

Terminal
```
upsun push
```
Iterate by changing the code, committing, and deploying. When satisfied with your changes, merge them to the main branch, and remove the feature branch:

Terminal
```
upsun merge
    Are you sure you want to merge feat-a into its parent, main? [Y/n] y
upsun checkout main
git pull upsun main
upsun environment:delete feat-a
git fetch --prune
```
Note that deploying to production is fast because the image built for the feat-a environment is reused.

For a long running branch, to keep the code up-to-date with the main branch, use git merge main or git rebase main. You can also keep the data in sync with the production environment by using upsun env:sync.

Integrated environments

Supported environments

Deploy Next.js on Upsun

Back to home

On this page

Is this page helpful?

Note

Before you begin

1. Create a Next.js app

Note

2. Create a new project

Remember

Note

Note

Tip

3. Choose your Git workflow

Note

4. Configure your project

5. Deploy

Tip

6. Make changes to your project

Further resources

Documentation

Community content

Blogs

Is this page helpful?