llms-txt-version: 1.0

Upsun

Upsun is a Cloud Application Platform to host all of your web applications.

Things to remember when deploying applications on the Upsun Cloud Application Platform:

• Ultimate developer flexibility: Self-service. Usage-based pricing. Customize your resources, runtimes, users, frontends, backends, APIs. All the choices are yours. Welcome to the Upsun PaaS.
• Application development your way, 4 options to get started sync your GitHub repo with Upsun, Deploy an existing local Git repository, Kickstart a new repository, Explore Upsun with our Demo app
• Agnostic freedom: Tight integration with external systems, stacks, and tools you already use. Choice of IaaS platform(by geo or cloud provider) and services. Choose the road you want to travel.
• Self-service: All the control and customization you want to experiment. Flexible resources. Sensible, transparent, usage-based pricing. Choose self-empowerment.
• Composable infrastructure: Dozens of runtimes and backend services to mix and match, Managed routing, with built-in, multiregional edge-caching, automated TLS, and WAF, Full infrastructure preview environments, isolated, but identical to production, Full abstraction from underlying cloud provider; runs precisely the same way on every major cloud
• Collaboration-oriented: The ability to collaborate on the infrastructure just like you collaborate on code, Git-driven infrastructure with support for multiple repositories, Bi-directional Git integrations, activity scripts, and webhooks to plug into any external service, Instantly created preview environments—per branch, per PR, per team, per developer, per anything
• Scalable on every dimension: Vertical scaling of every component, horizontal scaling of applications and workers, Fully managed, multicloud edge-caching, From a single monolith to an automated service mesh, with microservices, workers' message queues, and multiple data backends, Built-in observability tools, with infrastructure metrics, built-in APM, profiling, and tracing
• Stability, security, responsibility: Automated high availability and failover of every infrastructure component, with automated and transparent security-patching, Fine-grained team permissions, with MFA everywhere—even on SSH, Short-lived SSH certificates, with MFA and external identity provider support, PCI DSS, SOC 2, GDPR compliance,
• Polyglot? Hyperglot? We glot you: Upsun supports an array of cool languages and frameworks. Monoliths. Microservices. Multistack. So you can keep your options open. Flexible. And future-proof.

Docs

Get started

Getting started with Upsun

• Setup
• Create a project: All you need to know about creating a new project with Upsun
• Configure your project: Configure your project
• JavaScript/Node.js: All you need to know about configuring a new Javascript/Node.js project with Upsun
• PHP: All you need to know about configuring a new PHP project with Upsun
• Python: All you need to know about configuring a new Python project with Upsun
• Set resources: Flexible resources on Upsun are easy to use. Find all you need to know about resources allocation there.
• Make changes to your project: How to work on a daily basis with an Upsun project?
• Local development: All you need to know about working locally with an Upsun project.
• Tethered: Sync your local Upsun with your remote environment to start contributing.
• Third party integrations
• Get support

How to deploy

Javascript/Node.js

• Deploy Express on Upsun: Complete the last required steps to successfully deploy Express on Upsun.
• Add a database to Express: Once your Express app has been deployed on Upsun, you might want to add a service to it.
• Deploy Next.js on Upsun: Complete the last required steps to successfully deploy Next.js on Upsun.
• Deploy Strapi on Upsun: Complete the last required steps to successfully deploy Strapi on Upsun.
• Add a database to Strapi: Once Your Strapi application has been deployed on Upsun, you might want to add and configure a service to your application.

Python

• Deploy Django on Upsun: Complete the last required steps to successfully deploy Django on Upsun.
• Deploy Flask on Upsun: Complete the last required steps to successfully deploy Flask on Upsun.

PHP

• Deploy Drupal on Upsun: Complete the last required steps to successfully deploy Drupal on Upsun.
• Deploy Laravel on Upsun: Complete the last required steps to successfully deploy Laravel on Upsun.
• Get started: See how to get started deploying Laravel on Upsun.
• Environment variables: Learn about the environment variables added by the Upsun CLI.
• Set up Redis: Setting up Redis for cache, sessions & queues
• Handle queues with Horizon: Setting up Laravel Horizon
• Cron jobs: Understand how to configure Laravel cron jobs.
• Blackfire: Set up a continuous observability strategy for your Laravel app with Blackfire.
• Debug with Laravel Telescope: Setting up Laravel Telescope for debugging Laravel
• FAQ: Troubleshoot issue you might encounter using Laravel, a PHP framework on Upsun.
• Deploy Magento on Upsun: Complete these steps to successfully deploy Magento on Upsun.
• Deploy Symfony on Upsun: Complete the last required steps to successfully deploy Symfony on Upsun.
• Get started: See how to get started deploying Symfony on Upsun.
• Symfony integration: Learn how to use the Symfony integration for a better Upsun experience.
• Environment variables: Learn about the environment variables added by the Symfony integration.
• Workers: Understand how to configure Symfony workers.
• Cron jobs: Understand how to configure Symfony cron jobs.
• Blackfire: Set up a continuous observability strategy for your Symfony app with Blackfire.
• Local development: Sync Upsun with your local environments to start contributing.
• FAQ: Troubleshoot issue you might encounter using Symfony, a PHP framework on Upsun.
• Symfony CLI Tips: Find out about the most useful commands when using the Symfony CLI.
• WordPress
• Composer WordPress: Complete the last required steps to successfully deploy WordPress on Upsun.
• WordPress Multisite: Complete the last required steps to successfully deploy a WordPress Multisite on Upsun.
• Bedrock WordPress: Complete the last required steps to successfully deploy Bedrock-based WordPress on Upsun using Bedrock.
• Vanilla WordPress: Complete the last required steps to successfully deploy Vanilla WordPress on Upsun.
• Pimcore PaaS: Learn about Pimcore's PaaS solution, powered by Platform.sh
• Shopware PaaS: Learn about Shopware's PaaS solution, powered by Platform.sh.

How to deploy AI

• Host AI Agents
• Hosting Model Context Protocal (MCP) Servers
• The Upsun MCP Server: The Upsun Model Context Protocol (MCP) Server allows users to perform infrastructure operations, monitor environments, and manage resources using natural language commands and AI assistants.

Learn

What is Upsun?

• Philosophy: Gain insight into the philosophy of Upsun.
• YAML: An overview of YAML and its use at Upsun.
• What YAML is: An introduction to what YAML is and how to create and modify YAML files.
• Upsun YAML structure: A description of the YAML file for Upsun.
• Upsun YAML tags: A description of custom YAML tags available for Upsun files.
• Structure: Learn about how your Upsun environments are structured and which files control that structure.
• Build and deploy: See how applications get built and deployed with Upsun.
• Get support: Find out how to get help if you're experiencing issues with Upsun.

Tutorials

• Convert to Upsun: How to convert from another hosting solution to Upsun.
• Converting from Upsun Fixed (formerly Platform.sh): Learn how to configure your Upsun Fixed app to work on an Upsun Flex project so that it's deployment-ready.
• Automate your code updates: Learn how to automate your dependency updates through a source operation.
• Restrict access to a service: Learn how to restrict access to a service using a worker and additional endpoints to the service.
• Exporting data: See how to export your code, files and service data.

Best practices

• HTTP caching: See your options for HTTP caching with Upsun.
• From monoliths through headless to microservices: Choose the best app topology depending on your needs.
• Keep your Git repository clean: To avoid performance issues, prevent your Git repository from becoming too large.

Reference

Configure apps

• Choose an image type: Configure your app and control how it's built and deployed on Upsun.
• Single-runtime image: See all of the options for controlling your apps and how they're built and deployed on Upsun.
• Composable image: Use Upsun's composable image to build and deploy your app.
• Image properties: Details about image properties in the Upsun config.yaml file
• access: An access dictionary that defines the access control for roles accessing app environments.
• additional_hosts: An additional hosts dictionary that maps hostnames to IP addresses.
• container_profile: Defines the container profile of the application.
• crons: A cron dictionary that defines scheduled tasks for the app.
• firewall: A firewall dictionary that defines the outbound firewall rules for the application.
• hooks: A hooks dictionary that defines which commands run at different stages in the build and deploy process.
• mounts: Directories that are writable even after the app is built.
• relationships: A dictionary of relationships that defines the connections to other services and apps.
• source: Contains information about the app’s source code and operations that can be run on it.
• variables: A variables dictionary that defines variables to control the environment.
• web: A web instance that defines how the web application is served.
• workers: Defines the list of worker names, which are alternate copies of the application to run as background processes.
• Source operations: Run automated code updates via source operations.
• Runtime operations: Set up runtime operations to run one-off commands on your project through the Upsun CLI.
• Configure what's served
• PHP with front controller: Start with a basic PHP app with a front controller for dynamic requests.
• Rewrite requests: Rewrite requests to be served by other parts of your app without directing users.
• Serve different paths: Serve directories at different places than where they are in your app.
• Static sites: Serve completely static sites
• Custom headers: Set custom headers for your static content such as custom content-types or limits to cross-origin usage.
• Set up multiple apps in a single project: Create multiple apps within a single project, such as a CMS backend connected to a frontend to display it.
• Choose a project structure: Explore possible code structures you can apply to your multiple application projects.
• Define routes: Learn about the many ways you can define routes between your apps.
• Define relationships: Find out how relationships are managed between your apps.
• Timezones: Learn more about the different timezones on Upsun and when you can customize them.
• Troubleshoot disks
• Troubleshoot mounts
• Use build and deploy hooks: Add custom scripts at different stages in the build and deploy process.
• Change hooks in different environments: Change what runs in your hooks depending on the current environment type.
• Comparison of hooks: What hooks are available in the build and deploy process and how to choose which to use.
• Use hooks with dependencies: Manage dependencies for your hooks, such as compiling Sass files as part of your build.
• Work with workers: Interact with your worker instances to handle background tasks for your apps.

Add services

• Chroma
• ClickHouse
• Elasticsearch (Search service): Elasticsearch is a distributed RESTful search engine built for the cloud.
• Gotenberg: Gotenberg is a user-friendly API for PDF files.
• Headless Chrome: Headless Chrome is a headless browser that can be configured on projects like any other service on Upsun.
• InfluxDB (Database service): InfluxDB is a time series database optimized for high-write-volume use cases such as logs, sensor data, and real-time analytics.
• Kafka (Message queue service): Apache Kafka is an open-source stream-processing software platform.
• MariaDB/MySQL (database service): See how to configure a MariaDB/MySQL server to store your data.
• MariaDB read-only replication: Configure and access read-only MariaDB replicas to ease the load on a primary database.
• External replication: In rare cases, it may be useful to maintain a replica instance of your MySQL/MariaDB database outside of Upsun on a remote server.
• Troubleshoot
• Memcached (Object cache): Memcached is a simple in-memory object store well-suited for application level caching.
• Mercure
• MongoDB (Database service): MongoDB is a cross-platform, document-oriented database.For more information on using MongoDB, see MongoDB's own documentation.
• Network Storage
• OpenSearch (search service): OpenSearch is a distributed RESTful search engine built for the cloud.
• PostgreSQL (Database service)
• Read-only replication: Configure and access read-only PostgreSQL replicas to ease the load on a primary database.
• Qdrant
• RabbitMQ (message queue service): See how to configure RabbitMQ for your messaging needs.
• Redis (Object cache)
• Solr (Search service)
• Valkey
• Varnish
• Vault key management service

Define routes

• Server Side Includes (SSI): SSI commands enable you to include files within other pages.
• HTTP cache: Upsun supports HTTP caching at the server level. Caching is enabled by default, but is only applied to GET and HEAD requests.
• HTTPS: Learn how to enable HTTPS for your site and configure TLS connections.
• Proxy routes: Pass requests to a location outside your Upsun project using proxy routes.
• Redirects: Managing redirection rules is a common requirement for web applications, especially in cases where you do not want to lose incoming links that have changed or been removed over time.

Manage resources

• How resources work on Upsun: Understand how resources work on Upsun Flex. Learn the differences between shared and guaranteed CPU, how RAM is allocated, and how to configure scalable resources for your apps.
• Resource initialization: Learn how resources are allocated by default upon first deployment, and how you can define a resource initialization strategy that better fits your needs.
• Resource configuration: Configure CPU, RAM, and disk storage on a per-environment basis so your apps and services can run smoothly.
• Autoscaling: Learn how autoscaling adjusts app instances based on CPU and memory usage to keep apps stable and cost-efficient under varying workloads.
• Guaranteed resources: Learn how Guaranteed CPU on Upsun provide dedicated CPU and memory allocations for consistent, high-performance workloads.
• Project build resources: Configure project build resources on Upsun.

Languages

• C#/.NET Core: Upsun supports deploying .NET applications by allowing developers to define a build process and pass its variables to the .NET Core build environment.
• Elixir: Upsun supports building and deploying applications written in Elixir. There is no default flavor for the build phase, but you can define it explicitly in your build hook. Upsun Elixir images support both committed dependencies and download-on-demand. The underlying Erlang version is 22.0.7.
• Go: Upsun supports building and deploying applications written in Go using Go modules. They're compiled during the Build hook phase, and support both committed dependencies and download-on-demand.
• Java: Java is a general-purpose programming language, and one of the most popular in the world today. Upsun supports Java runtimes that can be used with build management tools such as Gradle, Maven, and Ant.
• Moving to Upsun
• Tuning
• JavaScript/Node.js: Get started creating JavaScript apps with Node.js on Upsun.
• Debugging
• Manage Node.js versions: See how to manage different Node.js versions in your Upsun containers."
• PHP: Deploy PHP apps on Upsun.
• Extensions: See what PHP extensions are available with each PHP version on Upsun.
• PHP performance tuning
• PHP-FPM sizing: Learn how to adjust the maximum number of PHP-FPM workers for your app
• FrankenPHP
• Xdebug
• Custom Redis
• Swoole
• Authenticated Composer: Allow Composer to authenticate against a private third-party Composer repository and download PHP packages from it.
• Troubleshoot: Learn how to troubleshoot common issues in PHP.
• Python: Get started creating Python apps on Upsun.
• Manage dependencies: See how to manage Python dependencies with different package managers.
• Web servers: See how to start your apps as you wish with ASGI and WSGI servers.
• Python in non-Python containers: See how to manage different Python versions in your Upsun containers.
• Ruby: Upsun supports deploying any Ruby application. Your application can use any Ruby application server such as Puma or Unicorn and deploying a Rails or a Sinatra app is very straight forward.
• Rust

Development

• Set up your local development environment: Set up a local development environment to test out changes to your app's code.
• DDEV: Use DDEV to set up local development environments.
• Tethered
• Untethered
• Variables overview: Variables give you control over your project's build process and runtime environment. You can set them in your code to make changes across your project or independent of the code for environment-specific settings.
• Set variables: See how to set variables that you can later use to take control over your app's environment.
• Use variables: See how to use variables that have already been set so you can take control over your app's environment.
• Access your site: Find the URLs you can use to access your site via a web browser.
• Transfer files to and from your app
• HTTP Headers: Upsun adds a number of HTTP headers to both inbound and outbound messages. We don't modify or block existing headers on either request or response.
• Send email: Send email from your Upsun environments.
• Pull code from a private Git repository: See how to pull code from a private Git repository into your Upsun build process.
• Use Git submodules
• Connect securely with SSH: Keep your project and apps safe by connecting with SSH when you're interacting with your deployed environments or using the Upsun CLI.
• SSH keys: See how to authenticate your app connections using SSH keys.
• Troubleshoot SSH
• Regions: See information about Upsun regions, including their environmental impact and IP addresses.
• 502 error resolution guide: Diagnose and resolve common 502 errors that may prevent your Upsun app from starting or running correctly.
• Troubleshoot development: See some common solutions to issues you might run into in development.
• Sanitize databases: Remove sensitive information from databases on preview environments to control access.
• MariaDB and Drupal: Sanitize MariaDB data in preview environments directly or by using Drush.
• PostgreSQL and Django: Sanitize PostgreSQL data in preview environments for Django apps.
• PostgreSQL and Symfony: Sanitize PostgreSQL data in preview environments for Symfony apps.

Integrations

• External Integrations: Upsun can be integrated with external services.
• Activity scripts: Upsun supports custom scripts that can fire in response to any activity. These scripts allow you to take arbitrary actions in response to actions in your project, such as when it deploys, when a new branch is created, etc.
• Activity reference: A reference of the properties found in various activities.
• Utility routines: The following utility routines can help simplify common tasks in your activity scripts. They're free to copy, modify, bend, fold, spindle, and mutilate as needed for your own scripts. They also demonstrate some common patterns for working with the activity and project data structures.
• Example: Discord
• Example: Slack
• Webhooks: Webhooks allow you to host a script yourself externally that receives the same payload as an activity script and responds to the same events, but can be hosted on your own server in your own language.
• Source integrations: See how to maintain your code in a third-party repository that's linked to your Upsun project.
• Bitbucket: See how to manage your Upsun environments directly from your Bitbucket repository.
• GitHub: See how to manage your Upsun environments directly from your GitHub repository.
• GitLab: See how to manage your Upsun environments directly from your GitLab repository.
• Resolve access: Learn how to troubleshoot access rights for integrated repositories.
• Fastly CDN: The Fastly CDN integration provides a centralized interface within the Upsun Console to oversee your edge traffic, manage cache, edit access control lists (ACLs), and tune performance without switching platforms. You can also manage dynamic configuration by using Edge Dictionaries.
• Health notifications: Upsun can notify you when various events happen on your project, in any environment. At this time the only notification provided is a low disk space warning, but others may be added in the future.

Increase observability

• Infrastructure metrics: See all of the live infrastructure metrics available to give you an overview of resource usage.
• HTTP metrics: Understand HTTP metrics
• Understand metrics: Understand how to read metrics for Upsun environments.
• Application metrics: See how to better understand your applications' real behavior with live and detailed insights.
• Monitor Cron job executions: Learn how to visualize and interpret your Cron job runs directly in the console.
• Understanding application observablity: Understanding the differences between deterministic and probabilistic observability
• Blackfire for PHP and Python: A full access to Blackfire is bundled with your PHP and Python Upsun projects.
• Comparing Continuous Profiling Timeframes: Comparing continuous profiling timeframes
• Continuous Profiling dashboard: Understanding the Continuous Profiling dashboard
• Go continuous profiler: Configure and use the Go continuous profiler.
• Java continuous profiler: Configure and use the Java continuous profiler.
• Node.js continuous profiler: Configure and use the NodeJS continuous profiler.
• PHP continuous profiler: Configure and use the PHP continuous profiler.
• Python continuous profiler: Configure and use the Python continuous profiler.
• Ruby continuous profiler: Configure and use the Ruby continuous profiler.
• Rust continuous profiler: Configure and use the Rust continuous profiler.
• Consume logs: See how to access or forward logs to get increased insights into your apps and services.
• Access logs: Increase your knowledge of how your apps are performing by accessing their container and activity logs.
• Forward Upsun and Blackfire logs: Send your Upsun and Blackfire logs to a third-party service for further analysis.

Manage Upsun environments

• Back up an environment: See how to protect yourself from potential data loss by backing up your environments so they can be restored later.
• Restore an environment from a backup: See how to restore an environment from a previous state.
• Cancel an activity: See how to cancel running or pending activities in an environment.
• Change an environment's parent: Learn how to change.a given environment's parent environment.
• Configure HTTP access control: Learn how to control access to.a given environment using HTTP methods.
• Deactivate an environment: See how to deactivate environments you aren't using.
• Manage search indexing for an environment: Learn how to set up search indexing so only your live production site appears in search results.
• Rename the default environment: See how to change the name of your default/production environment after creating a project.

Manage projects

• Change a project's region: See how to change the region your project is in and why you might want to do so.
• Change the project timezone: See how to change the timezone for a project and what it affects.
• Delete a project: See how to delete projects you no longer need.

Custom domains

• Set up a custom domain: Add a custom domain to your project once it's ready to go live.
• DNS and apex domains: See why CNAME records are used and how to handle apex domains.
• Custom TLS certificates
• Handle subdomains: How to handle multiple subdomains in different projects.
• Preview environments: Learn how to set up custom domains on your preview environments
• Content delivery networks (CDNs): Improve performance for distributed end-users of your website with a content delivery network (CDN).
• Fastly setup: Learn how to configure your Fastly CDN.
• Managed Fastly CDN: Bring your content closer to users with a Fastly CDN fully managed by Upsun.
• Cloudflare setup: Learn how to configure your Cloudflare CDN.
• Going Live - Troubleshooting: If your site doesn't resolve after you've made DNS changes, check potential solutions to common issues.

Administration

• Command line interface (CLI): See how to use and manage your Upsun projects directly from your terminal. Anything you can do within the Console can be done with the CLI.
• API tokens
• Command reference
• Initialize a project: Generate starter configuration files for your Upsun project by using AI or guided setup.
• Console: Upsun provides a web console so you can interact with your projects and manage your environments.
• Configure a project: Configure settings that apply across a project, such as the name, access, and domain.
• Configure environments: Configure your environments including their name, status, and visibility.
• Organizations: See how to manage multiple Upsun projects at once through organizations.
• Administer teams: Manage team access and permissions across all your projects and organizations.
• Administer users: Manage user access and permissions across all your projects and organizations.
• Pricing: Understand how Upsun pricing works.
• Billing: Keep your billing details up to date and optimize cost management from the Console.
• Administer your billing: Keep your billing information up to date and redeem your vouchers from the Console.
• Monitor your billing information: Manage your costs efficiently by viewing monthly spend estimates and setting spend alerts.
• Payment FAQ: Learn about billing cycles, supported payment methods, accepted currencies, and fraud protection on Upsun.
• Subscribe to an add-on: Subscribe to add-ons to enhance your user experience.
• Server upgrades: Information about how Upsun updates servers
• Security: For enhanced security, enable Multifactor Authentication (MFA) or Single Sign-On (SSO).
• Multifactor Authentication (MFA): Enhance your organizations' security with Multifactor Authentication (MFA).
• Single Sign-On (SSO): Upsun enables you to set up mandatory SSO with a third-party identity provider (IdP) for all your users.

Security and compliance

• Fastly WAF: Find out about the offers you can choose from to subscribe to the Fastly Next-Gen Web Application Firewall (WAF) through Upsun.
• Upsun WAF: Learn how the WAF can help protect your site from distributed denial of service (DDoS) attacks.
• Data retention: Upsun logs and stores various types of data as a normal part of its business. This information is only retained as needed to perform relevant business functions. Retention periods vary depending on the type of data stored. If a legal obligation, law enforcement request, or ongoing business need so requires, data may be retained after the original purpose for which it was collected ceases to exist.
• Project isolation: Learn how project isolation is handled at Upsun

Glossary

Request features

API

• API Doc: documentation of the Upsun API.