With Novel Web

Novel can be used with or without Novel Web. However, If you would like to use it with Novel Web, or if you have used the express installation method; you would have Novel Web inside your /web directory.

Normally, the software would be able to detect if this is inside that directory.

But if you would want to deploy Novel Web separately into Vercel, like the tutorial below

Deploying to Vercel | Novel

You will need to perform a couple more steps.

In different server

1

Configure Novel API

Make sure you set the Novel API to know where the Novel Web instance is set. This is usually the domain for that instance

.env

HOST=https://canary.novel.dev
WEB_HOST=https://demo.novel.dev

...rest of your `.env`

2

Configure Novel Web

Add this environment variable in the server that you set up Novel Web on.

.env

NEXT_PUBLIC_API_HOST=https://canary.novel.dev
...rest of your `.env`

For example, with Vercel

Deploying to Vercel | Novel

In the same server

As long as Novel Web is inside the /web directory, Novel API will make sure it will serve it in the same host as the API.

No additional set up is required.

Changelog

• 2024-12-20 - Initial Documentation