Stormkit Logo
Stormkit Logo
+ K
docsblogwhats new?FAQpricingGitHubTwitterDiscordDiscordlogin
Welcome
Getting StartedContributingContact Us
Deployments
IntroductionConfigurationApplication RuntimeAuto DeploymentsOutbound WebhooksDeploy ButtonSystem VariablesHow Do We Deploy
Features
AnalyticsCustom HeadersCustom StorageFeature FlagsKey Value StoreMultiple EnvironmentsRedirects and Path RewritesSnippetsStaged RolloutsTeams and RolesTrigger FunctionsWriting Api

Configuration

Each environment in Stormkit has a configuration which is divided into two sections. The first section is the environment configuration, where you can provide the name of the environment, the branch it points to and whether auto publish is enabled or not.

Environment config
Setting Description
Environment name The name of the environment. Each application can have as many environments as needed. You cannot reuse the same environment name in a given application.
Branch Every environment is assigned a branch. When auto deployments are enabled, the commit will be built using the matching environment's configuration. If there is no environment matching for that branch, the default environment's configuration will be used.
Auto Publish When enabled, successfull deployments will be automatically published. When a deployment is published, the domain will point to that deployment.

Build Configuration

The second section is the build configuration, which will be used to build and deploy your application. Stormkit has a built-in support for the following frameworks: Nuxt.js, Next.js, Angular and Nest.js. We'll understand your publish folder directly from the framework configuration file.

If any other framework is used or no framework is used at all, the build configuration will display two additional fields:

Setting Description
Publish folder The publish folder will be uploaded to our CDN. This folder is expected to have an index.html at the top level.
Build command The build command to execute. You can chain multiple commands with the logical and (&&) operator. You can use bash commands as well.
Environment variables The environment variables that will be injected during build time. Variable names matching following regex will be obfuscated /secret|_key|password/i. These variables are also available for serverless functions runtime.

Special Environment Variables

Following environment variables could be used to configure Stormkit builder

Setting Description
SK_CWD This variable used to indicate which working directory Stormkit should point out in order to build. This is used for monorepo configurations.
SK_ENV_FILE If this is set to true Stormkit will inject contents of .env file during building process.