App Guides

Deploying a Feathers.js API App

This guide will help you deploy your Feathers.js API app to the Adaptable Cloud. In just a few clicks, Adaptable deploys all the cloud-based resources you need to run your Feathers app, including:

  • Building your app into Serverless Containers
  • Fully-managed Serverless Database (MongoDB, PostgreSQL, or MS SQL Server)
  • Autoscaling
  • Load Balancing
  • HTTPS (SSL/TLS)

»Step 1: Get your app ready

Before you get started deploying your existing app, you may want to review the Adaptable containerized app requirements.

»Set up your production config

Adaptable provides environment variables to your app with information about its hostname, what port to listen on, and how to connect to the fully-managed database that is deployed alongside your app.

tip

When using an Adaptable MongoDB database, your Feathers services should use either the feathers-mongoose or feathers-mongodb database adapters.

When using an Adaptable PostgreSQL or MS SQL Server database, your Feathers services should use either the feathers-sequelize or feathers-knex database adapters.

To use these environment variables in Feathers, edit your config/production.json file and ensure the following properties are set exactly like the ones below. Note that you only need one of either mongo, postgres, or mssql, corresponding to the type of database you wish to use on Adaptable.

{
    "host": "EXTERNAL_HOSTNAME",
    "port": "PORT",
    "mongo": "DATABASE_URL",
    "postgres": "DATABASE_URL",
    "mssql": "DATABASE_URL"
}

»Test your changes

To confirm your changes work as expected, try running your app in your development environment with the PORT environment variable set:

PORT=1234 npm run start

You should be able to connect locally to your app at http://localhost:1234

»Push to GitHub

Make sure that any changes you made to your project from the steps above have been committed to git and pushed to your GitHub repo.

»Step 2: Connect to GitHub

Start by clicking the button below:

Alternatively, you can go to your App Dashboard, then click the New App button and then Connect an Existing Repository.

If you haven't yet connected any of your GitHub repositories to Adaptable, click Connect GitHub Repository.

Choose which scope you'd like to connect Adaptable to. You can connect Adaptable to your personal GitHub scope or to an organization you're a member of.

And finally, click the Install & Authorize button.

»Step 3: Choose a GitHub repo to deploy

Next, choose the repo you'd like to deploy to the Adaptable Cloud.

If you don't see the repo you're looking for, click Add more GitHub repositories to authorize Adaptable on more of your repos or GitHub organizations.

List of GitHub repos

Then select the branch you'd like to deploy. Once connected, Adaptable sets up continuous deployment to build and deploy your repo each time you push to this branch.

»Step 4: Choose a Deploy Template

Since you're deploying a Feathers app, choose the Feathers.js API Template.

Choosing a deploy template

»Step 5: Review settings

The default settings for the Deploy Template are shown. For more information on each setting, click the help icon next to the setting or see the template documentation. To change a setting, click Change next to the setting you wish to change.

By default, Adaptable will run the "start" script from your package.json file. If you don't have a "start" script configured or wish to run a different command, change the Start Command on this screen.

example

If the entrypoint to your app is index.js, then you'd change Start Command to:

node index.js

When you're satisfied with the settings, click Next.

Reviewing template settings

»Step 6: Choose an app name

Choose a name for your app project on Adaptable. This name will be used to create a URL for your project like https://YOURAPPNAME.adaptable.app, so it must be unique among all other app names on Adaptable.

Enter your chosen app name and click Next.

»Step 7: Pre-flight checks

Adaptable will now perform some basic checks on your GitHub repo to ensure it's ready to deploy.

Most of the checks can be performed automatically. However, this screen asks you to manually confirm that your app listens for HTTP requests on the port specified by the environment variable PORT. (See Step 1 above.) Click the square checkbox to confirm.

For more information on any of the checks, see Pre-flight checks. If the checks do not pass or you have more questions on them, contact our support team for help.

When the checks have passed, click Deploy App to start deploying your new app.

Performing pre-flight checks

»Deployed!

Once deployment is complete, your app will be running at https://YOURAPPNAME.adaptable.app. You will be redirected to the app status page with a congratulations message if your app deployed successfully. Otherwise you'll get an error message and some help to resolve the error. In either case, you will have the option to take a tour to see how Adaptable works!

tip

Now that your app is set up on Adaptable, each time you push to the branch you selected on your GitHub repo, Adaptable will automatically deploy your code changes.

»Having trouble?

Look for the How to Fix This App tip box on your App Status page. It will help guide you toward logs and documentation appropriate for the error your app has.

If you need to make any code changes, you can push to your GitHub repo to update your app and Adaptable will re-deploy it.

If you're still having trouble deploying, contact our support team for help.

»Additional info

»Runtime Environment Variables

You can specify your own custom environment variables that will be available to your app while it is running. For more information on setting custom environment variables, see Customizing Your App Environment.

The template also automatically provides several pre-set environment variables to your app at runtime:

  • ADAPTABLE_TRUST_PROXY_DEPTH: When this variable is set, it indicates that the app is behind one or more reverse proxies. The value is an integer number of proxies that your app may trust in the X-Forwarded-For HTTP request header. If this variable is set, the X-Forwarded-Proto and X-Forwarded-Host HTTP request headers may also be trusted.

  • DATABASE_URL: This is the URL that your app should use to contact the database provisioned alongside your app. It will include the database protocol, port, and hostname, as well as the username, password, and specific database to connect to. It may also have additional query parameters containing database options. This URL can often be used directly by a library such as Sequelize. If you manually parse this URL, be aware that all special characters in each portion of the URL have been URL-encoded and should be decoded before use.
    Example: postgres://dbuser:secret@database-1.adaptable.io:1234/my-app-db?option=enabled

  • EXTERNAL_HOSTNAME: This is the externally visible host and domain name for your app.
    Example: my-app.adaptable.app

  • EXTERNAL_URL: This is the externally visible URL where your app users can contact your app. This will always begin with https://.
    Example: https://my-app.adaptable.app

  • NODE_ENV: This will always be set to production.

  • PORT: The TCP port that your app must listen on to receive incoming network requests. Your app is required to listen on this port. See containerized app requirements for more information.

Apps that use a PostgreSQL database will also have the following environment variables set:

  • PGDATABASE: The name of the database to connect to.

  • PGHOST: The hostname of the database cluster.

  • PGPASSWORD: The password to use when connecting to the database. Note that this environment variable may contain special characters.

  • PGPORT: The TCP port number to connect to.

  • PGUSER: The username to use when connecting to the database.

  • PGSSLMODE: Specifies whether to negotiate SSL/TLS with the database cluster. In Adaptable, this will always be verify-full. Adaptable-provisioned PostgreSQL databases require the use of SSL/TLS.

  • PGSSLROOTCERT: Path to a file containing SSL/TLS root certificates associated with the database cluster. In order for your PostgreSQL client to verify the database cluster's certificate, you must correctly configure your PostgreSQL client to verify using this root certificate.

Apps that use a Microsoft SQL Server database will also have the following environment variables set:

  • MSSQL_DATABASE: The name of the database to connect to.

  • MSSQL_HOST: The hostname of the database cluster.

  • MSSQL_PASSWORD: The password to use when connecting to the database. Note that this environment variable may contain special characters.

  • MSSQL_TCP_PORT: The TCP port number to connect to.

  • MSSQL_USER: The username to use when connecting to the database.

note

Runtime environment variables are not available during your app's build process.

»Containerized app requirements

In order to run your app on the Adaptable Container Service, it must meet a few requirements. Most web-based apps shouldn't have trouble meeting these requirements.

  • Your app must listen for HTTP requests on 0.0.0.0 on the TCP port specified by the PORT environment variable. (Alternatively, your app can listen on a fixed port, but you will have to specify this PORT in your App's settings after the first failed deploy.)

  • Your app must be stateless. Although your app can write to local disk storage, that storage is a memory file system and will be lost when your app is scaled down or updated. Local disk storage is also not shared between multiple autoscaled instances of your app. This means your app cannot use local file-based databases, such as NeDB or SQLite.

  • Your app cannot perform background activities outside the scope of request handling. Your app's CPU allocation is set to zero when your app is not processing a network request.

  • You should not perform HTTPS/TLS in your app itself. Adaptable automatically provides HTTPS/TLS via our highly scalable load balancing tier.

  • When your app starts, it must listen for HTTP requests within 4 minutes of being started.