How to Manage Static Sites in App Platform

Create a Static Site

Note

If a Static Site comprises the entirety of your App Platform app, you can use the usual app creation process. These instructions apply when a static site is just one resource that you’re adding to an existing app.

1. In the Apps section of the DigitalOcean Control Panel, select your app, then click the Actions button and choose Create Resources to add a Static Site.

2. Select the repository service to retrieve your source code from, either: GitHub, GitLab, DigitalOcean Container Registry, Docker Hub, or a sample app. If you are connecting to your repository from DigitalOcean for the first time, you will need to click the Manage Access button to provide DigitalOcean access to the repositories or containers, then refresh this page.

3. Select the repository from the Repository drop-down list. Next, select which branch of the source repo you’d like to use as the source. Optionally, for monorepos, specify the folder that contains the source in the Source Directory field. For containers, specify the image tag to use. Click Next.

   App Platform will inspect the code, select an appropriate resource type and also detect any appropriate build and run commands.

   

   To change to a different resource type, click the edit icon to open the Settings page of the resource. Click the Edit link next to Resource Type, choose another option from the Type drop-down list and click Save. Additionally, you can change the resource’s name, scaling behavior, edit the build and run commands, the HTTP port and request route, and more.

   

4. Optionally, if you want to specify additional resources, click the Add Additional Resource From Source link, repeat the procedure and click Next.

5. If you need to use environment variables, click Edit to the right of the resource name and supply them. Click the Encrypt checkbox to ensure a variable’s value is obscured in all build, deploy, and application logs.

   To specify an app-level environment variable, click Edit to the right of Global. Click Save and then click Next.

   

6. Review the resources, environment variables and pricing, and click Create Resources.

Configure a Static Site

In the Apps section of the DigitalOcean Control Panel, select your app and click on the Settings tab. Click the Static Site you’d like to edit.

You can use the configuration settings you see here to change the Static Site’s scaling behavior, modify environment variables, edit commands, and more.

When an error occurs on the static site, App Platform displays an error document. You can specify a custom error document. Click Edit in the Custom Pages section.

Select one of the following options:

• Error: Specify a document for errors for the site.

• Catchall: Specify a catch-all document that the site uses to redirect requests to pages that are not found on the site.

Enter the name of the error or catch-all document in the Page Name field and click Save. The .html file must be in your repository for App Platform to use it in the build. App Platform uses a default document if you do not provide one. For static sites that have Javascript-based client side routing, you can specify index.html as the catch-all document.

Destroy a Static Site

In the Apps section of the DigitalOcean Control Panel, select your app and click on the Settings tab. Click on the Static Site you’d like to destroy.

You can destroy the Static Site by clicking the Destroy Component button on the bottom of the page and entering its name to confirm your selection.

Related Topics

Build & Run Command

The build and run commands are the command-line statements that compile your app resource at build time and launch your app resource after it has been built, respectively.

Container

A container is a single running instance of a service, worker, or static site resource shipped on App Platform.

Static Site

In App Platform, a static site is a type of resource that only consists of a build process that produces static assets.