On this page
Welcome to the
Upsun documentation
Built for developers, by developers. The efficient, reliable, and secure Platform-as-a-Service (PaaS) that gives development teams control and peace of mind while accelerating the time it takes to build and deploy applications.
Resources to help you customize, experiment, and optimize all from one platform.
How the docs are organized 
There are different kinds of documentation. Some docs are useful when you’re just starting out, while others go into detail that’s relevant only after you’ve deployed many projects on Upsun.
This site is roughly split into categories based on where you are in your journey working with Upsun, described below.
Get started
If you’re still unfamiliar with Upsun and how it works, but you’re also looking to quickly start working with the platform, the Get started section is the right place to begin.
Learn the basics of how Upsun leverages Git to produce reusable build images, identical-to-production environments in staging and development (including production data), as well as the basics of monitoring and troubleshooting your environments.
Ready to get started? Let’s go!
Learn
After going through the Get started section, you may want to know more about how Upsun works and the logic behind it. The Learn section is a collection of tutorials and conceptual guides to help you understand the ins and outs of Upsun.
-
With this guide, find out which problem Upsun is trying to solve. Learn how Upsun’s configuration, build and deploy pipelines, and the structure of environments play into the broader philosophy behind reliably deploying applications.
-
Once you’re familiar with Upsun, its basic rules and philosophy, you may be curious about how you can replicate common workflows in other tools on our platform. From scheduling dependency updates and backups to exporting data, the Tutorials provide all the information you need.
-
Upsun makes deploying and managing infrastructure no different than working with Git. As your work becomes more experimental, however, you may be interested in optimizing your workflows, and addressing common constraints of the platform. The Best practices documentation contains articles that address advanced use cases for caching, microservices, and more.
Frameworks
Now that you understand the basic rules of Upsun, you’re likely ready to deploy your own custom code in a chosen framework. The Frameworks section is a collection of framework-specific how-to guides - from best practices to configuration, local development, and more.
| Language | Frameworks |
|---|---|
| Python | Django Flask |
| PHP | Laravel Symfony WordPress |
| Javascript/Node.js | Express Next.js Strapi |
Reference
The Reference documentation section is the largest and most comprehensive. It includes details of configuration, environment variables, activities, and much more material you can use in your day-to-day work.
API documentation
Find out more about Upsun’s GIT implementation and REST API, and how you can leverage them to manage every aspect of your projects, through Upsun’s API documentation.
Connect with us
Join the community
The Upsun community meets on both a Community forum and Discord for questions and discussion.
Have an experiment you’d like to share? Looking for a way to contribute?
Contribute
Feel free to open an issue or pull request for any of the repositories below, or let us know on Discord if you find a problem we can help with:
Get support
If you’re experiencing issues with your projects, don’t hesitate to open a support ticket.