Skip to content

Create a Docker Compose App

Creating an app involves four steps: Choose the app, Domain, Environment and Confirm and deploy. You can navigate back to earlier steps at any point before you deploy.

Review the prerequisites in Before you begin on the overview page. Only team owners and team admins can create apps.

Open your server's Sites page, click Create New Site, and select Docker Compose App in the dialog. The card displays a Beta badge.

The Create Site dialog with the Docker Compose App card ringed

Choose your server first. If a server can't host an app, its card explains why, such as a trial server, a server that is still being set up, or a server with too little memory.

On Choose the app, pick one of three ways to provide your app configuration, or start from a template:

  • Paste a file lets you paste the text of a Compose file (up to 64 KB).
  • From GitHub imports a Compose file from a GitHub repository. Choose the repository, branch, and Compose file path, then click Read File. Connect your GitHub account first if your repository isn't listed.
  • From a link fetches a Compose file from a URL. Paste the full URL to the file (starting with https://), then click Fetch. FlyWP imports the file once, so subsequent updates at that link won't change your app.

FlyWP validates your file as you work. If there is an issue, FlyWP flags it next to the offending line with a clear explanation. Resolve any issues before continuing. To learn what the validator accepts and blocks, see Compose file rules.

Templates are ready-made Compose files for popular apps. They come from the public flywp/compose-templates repository on GitHub. FlyWP keeps a copy of the catalogue and refreshes it from the repository every hour.

  1. On Choose the app, stay on Paste a file and leave the editor empty.
  2. Click Start from Template under the editor. The button isn't shown once the editor has text, so a file you pasted is never replaced.
  3. Search by name, or pick a category. The count at the bottom shows how many templates match.
  4. Click a template to open its details, then click Use This Template. Click Back to Templates to return to the list.

The Start from Template window listing the available templates with a search box and categories

The details of the Vaultwarden template with what it needs, what FlyWP makes and the Use This Template button

The details show what the template needs and does:

DetailWhat it tells you
NeedsMemory, CPU and disk the app needs.
ServicesThe containers it runs and their images.
FlyWP makesThe passwords and keys FlyWP generates when it deploys. You never type them.
You fill inSettings you enter on the Environment step, such as Admin email.
LicenceThe app's licence and what it means for you.
WebsiteThe app's own website.
After it runsWhat to do first once the app is up.

Each card also shows the memory the app needs, such as Needs 1.3 GB memory. If the template needs more memory than your server has free for apps, the badge turns to a warning, and the details tell you to choose another server on the Confirm and deploy step.

Use This Template puts the template's Compose file in the editor. You can still change the file. It also pre-fills the rest of the flow:

  • FlyWP generates each password and key when it deploys, and fills in the template's address variables for you.
  • Settings that the template asks for appear on the Environment step. A template setting marked secret starts as a secret.
  • On the Confirm and deploy step, App name starts as the template's name, and the domain goes to the template's service and port. You can change both.

After you pick a template, a line above the editor reads From the template with the template's name. Click Change Template to pick another one.

If no templates are available yet, the Start from Template button doesn't appear. Paste a file, or use GitHub or a link instead.

On Domain, configure how visitors reach your app:

  • Turn on Use flywp.xyz test domain to have FlyWP generate a testing subdomain.
  • Enter your own hostname in Domain Name for a custom domain.

The Domain step with a custom domain and its DNS record

For a custom domain, you can tick Add DNS record on Cloudflare to let FlyWP create the DNS record for you automatically. Otherwise, point the hostname to your server yourself. The step shows the A records to add. Click Check DNS to test them: a green check mark appears next to each name whose record points to your server, and a red cross appears next to any other name. You can deploy before the record is ready. The app answers on your domain once the record points to the server, and FlyWP then gets the HTTPS certificate. The app's Domains page shows the state after deployment. Enable HTTPS is always on for an app.

Test domains are intended for testing only. Use your own domain for a live site.

On Environment variables, FlyWP lists the variables your Compose file reads. Each variable includes a Value field. Turn on Secret to hide sensitive values on screen. If the file reads none, click Add Variables to add one the app needs.

With a template, FlyWP leaves out the passwords, keys and address variables it makes itself, and lists the settings you need to fill in, such as Admin email.

The Environment step with two variables, one of them secret

To fill multiple variables at once, paste the text of a .env file and click Import .env. FlyWP automatically ignores comment lines and empty lines, and strips surrounding quotes from values. Only variables used by your app will receive values from the pasted text.

On Confirm and deploy, check the App name. FlyWP suggests the template name, or the repository name for a GitHub app. Change it if you like. Then review the summary and click Deploy:

  • Server shows the server and how much memory is free for apps. Click Change to choose another server.
  • Domain shows your domain, or Free test domain. Click Edit to go back to the Domain step.
  • Goes to shows the service and port that the domain reaches. Click Change to pick another service or port.

The Safety check lists what FlyWP found in your file. Click Hide Details or Show Details to collapse the list when nothing is blocked. If a line is blocked or the app doesn't fit on the server, the details stay open and Deploy stays off until you fix it. See Compose file rules.

The Confirm and deploy step with the app name, server, domain and safety check

The deploy runs in the background, so you can safely leave the page while it finishes. Open the app from the server's site list to follow its progress. When deployment completes, the app status switches to running and the domain starts serving your app.

If an initial deploy fails, your app stays in the dashboard alongside its deploy log. Check the last lines of the log to diagnose the problem, adjust your Compose file or environment variables, and deploy again from the Deploys page. See Deploys.

Still stuck? How can we help?

View as Markdown