Accéder au contenu principal

Providers

Analog supports deployment to many providers with little or no additional configuration using Nitro as its underlying server engine. You can find more providers in the Nitro deployment docs.

Zerops​

info

Zerops is the official deployment partner for AnalogJS.

Analog supports deploying both static and server-side rendered apps to Zerops with a simple configuration file.

One Zerops project can contain multiple Analog projects. See example repositories for static and server-side rendered Analog apps for a quick start.

Static (SSG) Analog app​

If your project is not SSG Ready, set up your project for Static Site Generation.

1. Create a project in Zerops​

Projects and services can be added either through a Project add wizard or imported using a YAML structure:

project:
  name: recipe-analog
services:
  - hostname: app
    type: static

This creates a project called recipe-analog with a Zerops Static service called app.

2. Add zerops.yml configuration​

To tell Zerops how to build and run your site, add a zerops.yml to your repository:

zerops:
  - setup: app
    build:
      base: nodejs@20
      buildCommands:
        - pnpm i
        - pnpm build
      deployFiles:
        - public
        - dist/analog/public/~
    run:
      base: static

3. Trigger the build & deploy pipeline​

Server-side rendered (SSR) Analog app​

If your project is not SSR Ready, set up your project for Server Side Rendering.

1. Create a project in Zerops​

Projects and services can be added either through a Project add wizard or imported using a YAML structure:

project:
  name: recipe-analog
services:
  - hostname: app
    type: nodejs@20

This creates a project called recipe-analog with a Zerops Node.js service called app.

2. Add zerops.yml configuration​

To tell Zerops how to build and run your site, add a zerops.yml to your repository:

zerops:
  - setup: app
    build:
      base: nodejs@20
      buildCommands:
        - pnpm i
        - pnpm build
      deployFiles:
        - public
        - node_modules
        - dist
    run:
      base: nodejs@20
      ports:
        - port: 3000
          httpSupport: true
      start: node dist/analog/server/index.mjs

3. Trigger the build & deploy pipeline​

Build & deploy your code​

Trigger the pipeline by connecting the service with your GitHub / GitLab repository​

Your code can be deployed automatically on each commit or a new tag by connecting the service with your GitHub / GitLab repository. This connection can be set up in the service detail.

Trigger the pipeline using Zerops CLI (zcli)​

You can also trigger the pipeline manually from your terminal or your existing CI/CD by using Zerops CLI.

  1. Install the Zerops CLI.
# To download the zcli binary directly,
# use https://github.com/zeropsio/zcli/releases
npm i -g @zerops/zcli

  1. Open Settings > Access Token Management in the Zerops app and generate a new access token.

  2. Log in using your access token with the following command:

zcli login <token>
  1. Navigate to the root of your app (where zerops.yml is located) and run the following command to trigger the deploy:
zcli push

Trigger the pipeline using GitHub / Gitlab​

You can also check out Github Integration / Gitlab Integration in Zerops Docs for git integration.

Netlify​

Analog supports deploying on Netlify with no additional configuration.

Deploying the project​

Configuration is easiest when using Netlify CLI.

  1. Start by running this command:
npx netlify init

If this is a new Netlify project, you'll be prompted to initialize it; build settings will be automatically configured in a netlify.toml file.

  1. Deploy your app:
npx netlify deploy

Manual configuration​

Alternatively, you can configure your project's build settings in the Netlify app.

Set the publish directory to dist/analog/public to deploy the static assets and the functions directory to netlify/functions to deploy the server.

Vercel​

Analog supports deploying on Vercel with no additional configuration.

Deploying the Project​

By default, when deploying to Vercel, the build preset is handled automatically.

  1. Create a new project and select the repository that contains your code.

  2. Click 'Deploy'.

And that's it!

Setting the Preset Manually​

There might be a case where Vercel doesn't load the preset automatically. In that case, you can do one of the following.

  • Set the BUILD_PRESET environment variable to vercel.
  • Set the preset in the vite.config.ts file:
import { defineConfig } from 'vite';
import analog from '@analogjs/platform';

// https://vitejs.dev/config/
export default defineConfig(({ mode }) => ({
  /// ...other config
  plugins: [
    analog({
      nitro: {
        preset: 'vercel',
      },
    }),
  ],
}));

Cloudflare Pages​

Analog supports deploying to Cloudflare Pages with minimal configuration.

Deploying to Cloudflare​

To connect your repository and deploy automatically to Cloudflare:

  1. Log in to the Cloudflare dashboard and select your account.
  2. In Account Home, select Workers & Pages.
  3. Select Create application > Pages > Connect to Git.
  4. Enter npm run build as the Build Command.
  5. Enter dist/analog/public as the Build output directory.
  6. Leave the other default settings, click Save and Deploy.

The application deploys to Cloudflare's network on each push to the repository.

Nx and Cloudlfare​

For Nx workspaces, the build output is under the app name. Update the Build output directory accordingly.

For example:

Build output directory: dist/[your-project-name]/analog/public

To test the build locally, run the following command:

BUILD_PRESET=cloudflare-pages npx nx build [your-project-name]

Running the application locally using Wrangler​

You can also preview the application running on Cloudflare locally:

  1. Set the environment variable BUILD_PRESET to cloudflare-pages before running the build
BUILD_PRESET=cloudflare-pages npm run build
  1. Use the wrangler CLI to run the application locally
npx wrangler pages dev ./dist/analog/public

Firebase App Hosting​

Analog supports Firebase App Hosting with no additional configuration out of the box.

Note: You need to be on the Blaze plan to deploy Analog applications with Firebase App Hosting.

Follow the Getting Started instructions to connect your GitHub repository to Firebase App Hosting.

Firebase Hosting​

Analog supports Firebase Hosting with Cloud Functions and Firebase App Hosting out of the box.

See a Sample Repo with Firebase configured

Note: You need to be on the Blaze plan to use Analog with Cloud Functions.

If you don't already have a firebase.json in your root directory, Analog will create one the first time you run it. In this file, you will need to replace <your_project_id> with the ID of your Firebase project.

This file should then be committed to version control. You can also create a .firebaserc file if you don't want to manually pass your project ID to your firebase commands (with --project <your_project_id>):

{
  "projects": {
    "default": "<your_project_id>"
  }
}

Then, just add Firebase dependencies to your project:

npm install -D firebase-admin firebase-functions firebase-functions-test

Using Firebase CLI​

If prefer to set up your project with the Firebase CLI, which will fetch your project ID for you, add required dependencies (see above) and even set up automated deployments with GitHub Actions.

Install Firebase CLI globally​

npm install -g firebase-tools

Note: You need to be on ^11.18.0 to deploy a nodejs18 function.

Initialize your Firebase project​

Login to Firebase and select the Hosting and Functions options as shown below:

firebase login
firebase init
 ◉ Functions: Configure a Cloud Functions directory and its files
 ◉ Hosting: Configure files for Firebase Hosting and (optionally) set up
GitHub Action deploys

Unless you have an existing Firebase project, select Create a new project to continue. Firebase will provision a new project and provide the URL to access the web console to manage it.

Once your project is created, select TypeScript as the language to use to write Cloud Functions. Proceed with accepting the default parameters by pressing Enter.

When prompted for the public directory, enter dist/analog/public.

In the next step, take the default option, N, on whether to configure as a single-page app. This is important! Do not configure your project as a single-page app.

After setup completes, ensure that the following properties are configured correctly in your firebase.json file. This ensures server-side rendering will work correctly with Cloud Functions:

{
  "functions": {
    "source": "dist/analog/server"
  },
  "hosting": [
    {
      "site": "<your_project_id>",
      "public": "dist/analog/public",
      "cleanUrls": true,
      "rewrites": [
        {
          "source": "**",
          "function": "server"
        }
      ]
    }
  ]
}

You can find more details in the Firebase documentation.

Firebase functions​

Ensure that you set up Firebase functions as described in the previous section. Next, you must configure Nitro correctly for Firebase Cloud Functions to work.

In vite.config.ts update the nitro property with the configuration options that fit your needs, like your Node.js version and preferred region.

nitro: {
  preset: 'firebase',
  firebase: {
    nodeVersion: '20',
    gen: 2,
    httpsOptions: {
      region: 'us-east1',
      maxInstances: 100,
    },
  },
},

Alternatively, multiple AnalogJS projects (/app1, /app2) in a single Firebase Hosting site​

This leverages cloud run services to host AnalogJS projects and uses rewrite rules for forwarding traffic from firebase to cloud run.

Deploying with a custom URL prefix.

{
  "hosting": [
    {
      "site": "<your_project_id>",
      "public": "public",
      "cleanUrls": true,
      "rewrites": [
        {
          "source": "/app1",
          "run": {
            "serviceId": "app1",
            "region": "us-central1",
            "pinTag": false
          }
        },
        {
          "source": "/app1/**",
          "run": {
            "serviceId": "app1",
            "region": "us-central1",
            "pinTag": false
          }
        }
      ]
    }
  ]
}

Local preview​

You can preview a local version of your site to test things out without deploying.

BUILD_PRESET=firebase npm run build
firebase emulators:start

Deploy to Firebase Hosting using the CLI​

To deploy to Firebase Hosting, run the firebase deploy command.

BUILD_PRESET=firebase npm run build
firebase deploy

Firebase Warnings​

When configuring or deploying Firebase you may see warnings like:

npm WARN EBADENGINE Unsupported engine {
npm WARN EBADENGINE   package: undefined,
npm WARN EBADENGINE   required: { node: '18' },
npm WARN EBADENGINE   current: { node: 'v20.11.0', npm: '10.2.4' }
npm WARN EBADENGINE }
 ⚠  functions: Couldn't find firebase-functions package in your source code. Have you run 'npm install'?

These are benign errors and can be ignored, so long as you make sure your environment configuration matches Nitro.

Render.com​

Analog supports deploying on Render with minimal configuration.

Web Service Deployment​

  1. Create a new Web Service and select the repository that contains your code.

  2. Ensure the 'Node' environment is selected.

  3. Specify your Node version for Render to use (v18.13.0 or higher recommended) - Render by default uses Node 14, which fails to correctly build an Analog site

  4. Depending on your package manager, set the build command to yarn && yarn build, npm install && npm run build, or pnpm i --shamefully-hoist && pnpm build.

  5. Update the start command to node dist/analog/server/index.mjs

  6. Click 'Advanced' and add an environment variable with BUILD_PRESET set to render-com.

  7. Click 'Create Web Service'.

Static Site Deployment​

If using Analog to pre-render static content, you can deploy a static site on Render with minimal configuration

  1. Create a new Static Site and select the repository that contains your code.

  2. Depending on your package manager, set the build command to yarn && yarn build, npm install && npm run build, or pnpm i --shamefully-hoist && pnpm build..

  3. Set the publish directory to the public directory inside of the dist build directory (e.g. dist/analog/public)

  4. Click 'Create Static Site'

Edgio​

Analog supports deploying on Edgio with minimal configuration.

  1. Install the Edgio CLI:
npm i -g @edgio/cli
  1. In your project's directory, initialize Edgio:
edgio init --connector=@edgio/analogjs
  1. Deploy To Edgio
edgio deploy

GitHub Pages (Static Site Deployment)​

Analog supports deploying a static site on GitHub Pages. When deploying your site to GitHub Pages, you must add an empty file called .nojekyll in the root directory of the gh-pages branch.

You can automate the deployment using the Analog Publish Github Pages action:

name: Build and Deploy

on:
  push:
    branches:
      - 'main'

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20.x'
      - uses: k9n-dev/analog-publish-gh-pages@v1.0.0
        with:
          access-token: ${{ secrets.ACCESS_TOKEN }}
          # further options are available.
          # see: https://github.com/marketplace/actions/analog-publish-github-pages

Or you can do it by your own like this:

name: Build Deploy

on:
  push:
    branches:
      - '*' # deploy on all branches (but a --dry-run flag is added for branches (see code below))

env:
  TARGET_DIR: dist/analog/public

jobs:
  # build the project and push it to the gh-pages branch
  build-and-push:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20.x'
      - name: Set environment variable based on branch
        run: |
          if [[ $GITHUB_REF == refs/heads/main || $GITHUB_REF == refs/heads/master ]]; then
            echo "Branch is main or master. Setting DRY_RUN_OPTION to empty."
            echo "DRY_RUN_OPTION=" >> $GITHUB_ENV
          else
            echo "Branch is not main or master. Setting DRY_RUN_OPTION to '--dry-run'."
            echo "DRY_RUN_OPTION=--dry-run" >> $GITHUB_ENV
          fi
      - name: Install
        run: npm ci
      - name: Build
        run: npm run build
      - name: Deploy Website (gh-pages branch)
        env:
          GH_TOKEN: ${{ secrets.ACCESS_TOKEN }} # A token must be created to be able to deploy on the gh-pages branch
          CNAME_OPTION: --cname=yourdomain.dev # omit if your not running it on a custom domain
        # run the deployment script to push the built project to the gh-pages branch
        # the default contributor is github-actions[bot]
        run: |
          echo "DRY_RUN_OPTION=$DRY_RUN_OPTION"
          npx angular-cli-ghpages --no-silent --dir="${{env.TARGET_DIR}}" \
            --name="github-actions[bot]" \
            --email="github-actions[bot]@users.noreply.github.com" \
            --branch="gh-pages" \
            --message="Deploy: $(git log -1 --pretty=%B)" \
            $DRY_RUN_OPTION

  # deploy from gh-pages branch
  deploy-pages:
    needs: build-and-push
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Checkout gh-pages
        uses: actions/checkout@v4
        with:
          ref: gh-pages

      - name: Setup Pages
        uses: actions/configure-pages@v4

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: '.'

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4