Skip to content

Apps

Deploy an app

To deploy an app, run the following command:

edge deploy
You have 2 deployment options: - Deploy from Git - Deploy from a local directory

To learn more about the two (2) different options, check here https://docs.simplifyd.com/how-deploys-work/.

This command starts a build process. The source code is either cloned from the specified git repo or from the local directory the command is run in and turned into a build artifact. The build artifact is then deployed on a runner. A Simplifyd vanity URL is associated with your deployed app so that you can view it in a browser. Note that deploying an app consumes resources that you would be charged for. Listing your apps shows the status of the app and the Simplifyd vanity URL if the app has been deployed.

Every app is deployed into an environment. Out of the box, Simplifyd Cloud provides the following three (3) deployment environments: - Production - Preview - Staging

If no environment is specified when the deploy command is run, the preview environment is assumed.

To speciy an environment to deploy your app to add the following flags to the deploy command:

for production:

edge deploy -e production
or
edge deploy --environment production

for preview:

edge deploy -e preview
or
edge deploy --environment preview

for staging:

edge deploy -e staging
or
edge deploy --environment staging

List all apps

You can list all apps by running the following command:

edge get apps

Update environment variables of app

To update the environment variables of an app, run the following command:

edge set envs -e production < env.sample
This command extracts all the environment variables defined in the env.sample file and configures the environment the app is deployed into with them. If no environment is specified when the command is run, the preview environment is assumed. Note that this is a replace operation not a modify operation. The current environment variables would be replaced entirely by the new ones specified with this command.

Add custom domains

To add a custom domain to an already deployed app, run the following command:

edge add domains
For the command to be successful, you must have configured your DNS settings properly. You need to add a CNAME DNS record where you point your custom domain to the Simplifyd domain shown. When this is done, you should be able to now access the app on the custom domain you provided. SSL certificates would be handled automatically by Simplifyd. In some rare cases you might need to wait for up to 5 minutes for the process to complete.

Undeploy app

To undeploy an app, run the following command:

edge undeploy

If no environment is specified when the undeploy command is run, the preview environment is assumed.

To speciy an environment to undeploy your app from, add the following flags to the undeploy command:

for production:

edge undeploy -e production
or
edge undeploy --environment production

for preview:

edge undeploy -e preview
or
edge undeploy --environment preview

for staging:

edge undeploy -e staging
or
edge undeploy --environment staging

Delete app

To completely delete an app, run the following command:

edge destroy