Guides

Remix

This guide shows how to deploy a Remix app.

To do so, follow these steps:

1. Install the kraft CLI tool and a container runtime engine, for example Docker.

2. Clone the examples repository and cd into the examples/node21-remix/ directory:

Code(bash)
 
git clone https://github.com/kraftcloud/examples
cd examples/node21-remix/

Make sure to log into Unikraft Cloud by setting your token and a metro close to you. This guide uses fra (Frankfurt, 🇩🇪):

Code(bash)
 
# Set Unikraft Cloud access token
export UKC_TOKEN=token
# Set metro to Frankfurt, DE
export UKC_METRO=fra

When done, invoke the following command to deploy the app on Unikraft Cloud:

Code(bash)
 
kraft cloud deploy -p 443:3000 -M 512 .

The output shows the instance address and other details:

Code(ansi)
 
[●] Deployed successfully!
 │
 ├────────── name: node21-remix-jvj6b
 ├────────── uuid: 4e6ccb1f-0533-4dc1-be67-eca8dfc1f8c6
 ├───────── state: running
 ├─────────── url: https://long-star-1tms9h1z.fra.unikraft.app
 ├───────── image: node21-remix@sha256:300eefce3de136ad9c782f010b69da01100ae5f0ca17f038f92321d735d6675f
 ├───── boot time: 153.47 ms
 ├──────── memory: 512 MiB
 ├─────── service: long-star-1tms9h1z
 ├── private fqdn: node21-remix-jvj6b.internal
 ├──── private ip: 172.16.6.8
 └────────── args: /usr/bin/node /usr/src/server.js

In this case, the instance name is node21-remix-jvj6b and the address is https://long-star-1tms9h1z.fra.unikraft.app. They're different for each run. You can now point your browser at the address to see your deployed instance.

You can list information about the instance by running:

Code(bash)
 
kraft cloud instance list

Code(text)
 
NAME                      FQDN                                STATE    CREATED AT      IMAGE          MEMORY   ARGS                              BOOT TIME
node21-remix-jvj6b        long-star-1tms9h1z.fra.unikraft.app  running  1 minutes ago   node21-rem...  256 MiB  /usr/bin/node /usr/src/server...  67.65 ms

When done, you can remove the instance:

Code(bash)
 
kraft cloud instance remove node21-remix-jvj6b

Customize your app

To customize the app, update the files in the repository, listed below:

• Kraftfile: the Unikraft Cloud specification
• Dockerfile: the Docker-specified app filesystem
• server.js: the server itself

Learn more

Use the --help option for detailed information on using Unikraft Cloud:

Code(bash)
 
kraft cloud --help

Or visit the CLI Reference.