docs.platform.sh
Open in
urlscan Pro
63.35.24.107
Public Scan
Submitted URL: http://docs.platform.sh/
Effective URL: https://docs.platform.sh/
Submission: On January 18 via api from GB — Scanned from GB
Effective URL: https://docs.platform.sh/
Submission: On January 18 via api from GB — Scanned from GB
Form analysis 1 forms found in the DOM
<form class=""><label class="sr-only" for="searchwicon">Search our docs</label>
<div class="flex items-center"><input id="searchwicon" placeholder="What are you looking for?" class="bg-no-repeat bg-[length:15px_15px] bg-left-4 h-16 w-full pl-12 text-slate border-none focus-visible:outline-none " autocomplete="off" value=""
style="background-image: url("/images/svg/search-solid.svg");"></div>
</form>Text Content
Search our docs
Log in Free trial
SITE NAVIGATION
GET STARTED
INTRODUCTION
DEPLOY
* Git init
* Git commit
ADD DATA
* Git branch
* Git merge
MONITOR AND TROUBLESHOOT
* Git log
* Git status
LEARN
WHAT IS PLATFORM.SH?
* Philosophy
* YAML
* What YAML is
* Platform.sh YAML tags
* Structure
* Build and deploy
* Get support
TUTORIALS
* Automate your code updates
* Restrict service access
* Exporting data
* Migrating to Platform.sh
BEST PRACTICES
* HTTP caching
* Monolith, headless or microservices?
* Keep your Git repository clean
MORE RESOURCES
FRAMEWORKS
PYTHON
DJANGO
* Get started
* Configure
* Customize
* Deploy
* Next steps
* Local development
INTEGRATED ENVIRONMENTS
* DDEV
SUPPORTED ENVIRONMENTS
* Tethered local
PHP
DRUPAL
* Get started
* Configure
* Customize
* Deploy
* Next steps
* Elasticsearch
* Memcached
* Multi-site
* Redis
* SimpleSAML
* FAQ
IBEXA DXP
* Get started
* Fastly
SYMFONY
* Get Started
* Symfony Integration
* Environment Variables
* Workers
* Cron Jobs
* Blackfire
* Local development
* FAQ
LARAVEL
* Get started
* Configure
* Laravel Bridge
* Scheduling tasks
* Blackfire
* Octane
* Deploy
* Local development
* DDEV
* Lando
TYPO3
* Get started
* Configure
* Customize
* Deploy
* Next steps
WORDPRESS
* Get started
* Configure
* Customize
* Deploy
* Next steps
* Why use Composer?
* Upgrade to use Composer
* Deploy without Composer
* Configure
* Customize
* Deploy
* Next steps
* Redis
JAVASCRIPT/NODE.JS
GATSBY
* Get started
* Configure
* Deploy
* Next steps
* Headless CMS
* Drupal
* Strapi
* WordPress
NEXT.JS
* Get started
STRAPI
* Get started
* Configure
* Deploy
* Database Configuration
* SQLite
* PostgreSQL
* MySQL
* MongoDB
* Local development
* Strapi v3
* Strapi v4
* Adding frontends
* Gatsby
JAVA
HIBERNATE
* Get started
JAKARTA
* Get started
MICRONAUT
* Get started
* Configure
* Customize
* Deploy
* Next steps
* Elasticsearch
* Micronaut Data
* MongoDB
* Redis
* JPA
QUARKUS
* Get started
* Configure
* Customize
* Deploy
* Next steps
* Elasticsearch
* JPA
* MongoDB
* Panache
* Redis
SPRING
* MariaDB/MySQL
* PostgreSQL
* RabbitMQ
* Solr
* Get started
* Configure
* Customize
* Deploy
* Next steps
* Elasticsearch
* JPA
* MongoDB
* Redis
REFERENCE
CONFIGURE APPS
* App reference
* Source operations
* Runtime operations
* Configure what’s served
* PHP with front controller
* Rewrite requests
* Serve different paths
* Static sites
* Custom headers
* Multiple apps
* Choose a project structure
* Define routes
* Define relationships
* Timezones
* Troubleshoot disks
* Troubleshoot mounts
* Upgrading
* Use build and deploy hooks
* Change hooks in different environments
* Comparison of hooks
* Use hooks with dependencies
* Work with workers
ADD SERVICES
* Elasticsearch Premium
* Headless Chrome
* InfluxDB
* Kafka
* MariaDB/MySQL
* MariaDB/MySQL Replication
* Troubleshoot
* Memcached
* MongoDB Premium
* Network Storage
* OpenSearch
* PostgreSQL
* RabbitMQ
* Redis
* Solr
* Varnish
* Vault KMS
DEFINE ROUTES
* Server Side Includes (SSI)
* HTTP cache
* HTTPS
* Proxy routes
* Redirects
LANGUAGES
* C#/.NET Core
* Elixir
* Go
* Java
* Frameworks
* Moving to Platform.sh
* Tuning
* JavaScript/Node.js
* Debugging
* Manage Node.js versions
* Lisp
* PHP
* Extensions
* Performance tuning
* PHP-FPM sizing
* Xdebug
* Custom Redis
* Swoole
* Authenticated Composer
* Troubleshoot
* Python
* Manage dependencies
* Web servers
* Python in non-Python containers
* Ruby
* Rust
DEVELOPMENT
* Project templates
* Local development
INTEGRATED ENVIRONMENTS
* DDEV
SUPPORTED ENVIRONMENTS
* Tethered
* Untethered
* Docksal
* Lando
* Variables overview
* Set variables
* Use variables
* Access your site
* Transfer files
* Headers
* Email
* Private repositories
* Git submodules
* Connect with SSH
* SSH keys
* Troubleshoot SSH
* Sync to Dedicated Gen 2
* Regions
* Troubleshoot
* Deploy on Platform.sh
* Sanitize databases
* MariaDB and Drupal
* PostgreSQL and Django
* PostgreSQL and Symfony
INTEGRATIONS
* Overview
* Activity scripts
* Activity reference
* Utility routines
* Example: Discord
* Example: Slack
* Webhooks
* Source integrations
* Bitbucket
* GitHub
* GitLab
* Resolve access
* Health notifications
INCREASE OBSERVABILITY
* Infrastructure metrics
* Dedicated Gen 2 metrics
* Dedicated Gen 3 metrics
* Grid metrics
* Integrate observability
IN-HOUSE OBSERVABILITY TOOL
* Blackfire
THIRD-PARTY OBSERVABILITY TOOLS
* New Relic
* Tideways
* Consume logs
* Access logs
* Forward Platform.sh and Blackfire logs
* Forward Fastly CDN logs
MANAGE ENVIRONMENTS
* Back up an environment
* Restore an environment
* Cancel an activity
* Change parent
* Configure HTTP access control
* Deactivate an environment
* Rename the default environment
* Scalability
* Set search engine visibility
MANAGE PROJECTS
* Change regions
* Change the project timezone
* Delete a project
CUSTOM DOMAINS
* Set up a custom domain
* DNS and apex domains
* Custom TLS certificates
* Handle subdomains
* Preview environments
* Content delivery networks
* Fastly setup
* Managed Fastly CDN
* Cloudflare setup
* Troubleshooting
ADMINISTRATION
* Command line interface (CLI)
* API tokens
* Console
* Configure a project
* Configure environments
* MFA
* Organizations
* Users
* Pricing
* Single sign-on (SSO)
* Server upgrades
SECURITY AND COMPLIANCE
* Backup and restore
* Data retention
* Web Application Firewall (WAF)
* Platform.sh WAF
* Fastly Next-Gen WAF
DEDICATED GEN 3
* Incident monitoring
* Security and data privacy
* Multiple availability zones
DEDICATED GEN 2
* Overview
* Incident Monitoring
* Security and privacy
* Updates and upgrades
* Backups
* Differences in development
* Features
* Deploying
* Dev environments
* Optional features
GLOSSARY
CHANGELOG
API DOCUMENTATION
ON THIS PAGE
* How the docs are organized
* Get started
* Learn
* Frameworks
* Reference
* API documentation
* Connect with us
* Get support
UPSUN BETA ACCESS
Test and provide feedback for our newest offering - Upsun!
You can register for the Beta by clicking here and completing the form.
Sign up for Upsun Beta
WELCOME TO THE
PLATFORM.SH 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.
Get started What is Platform.sh?
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 Platform.sh.
This site is roughly split into categories based on where you are in your
journey working with Platform.sh, described below.
GET STARTED
If you’re still unfamiliar with Platform.sh 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 Platform.sh 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
Platform.sh 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
Platform.sh.
* What is Platform.sh?
With this guide, find out which problem Platform.sh is trying to solve. Learn
how Platform.sh’s configuration, build and deploy pipelines, and the
structure of environments play into the broader philosophy behind reliably
deploying applications.
* Tutorials
Once you’re familiar with Platform.sh, 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.
* Best practices
Platform.sh 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 Platform.sh, 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 PHP Drupal
Ibexa
Laravel
Symfony
TYPO3
WordPress Javascript/Node.js Gatsby
Next.js
Strapi Java Hibernate
Jakarta
Micronaut
Quarkus
Spring
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.
Managed services
Services on our platform are managed. You can provision them with a few lines of
YAML and quickly connect them to the rest of your environment. No infrastructure
expertise is required.
Popular documentation:
* Elasticsearch
* Headless Chrome
* InfluxDB
* Kafka
* MariaDB/MySQL
* Memcached
* MongoDB
* Network Storage
* OpenSearch
* PostgreSQL
* RabbitMQ
* Redis
* Solr
* Varnish
* Vault KMS
Runtime languages
Like services, configure your application containers with one of many supported
runtime types.
Popular documentation:
* C#/.NET Core
* Elixir
* Go
* Java
* JavaScript/Node.js
* Lisp
* PHP
* Python
* Ruby
* Rust
Project & environment configuration
Delve deeper into how to configure containers, environments, projects, and
repositories.
Popular documentation:
* Application containers
* Services & data
* Routes & requests
* Environment variables
* Integrations & activities
* Regions
Advanced topics
Learn more about how you can customize and optimize your deployed projects, and
further experiment on the platform.
Popular documentation:
* Project administration
* Local development with DDEV
* Observability: Blackfire.io
* Observability: Infrastructure metrics
* Security & compliance
* Workers
* Sanitizing data
* Microservices and multi-app projects
* Submodules
* Private repositories
API DOCUMENTATION
Find out more about Platform.sh’s GIT implementation and REST API, and how you
can leverage them to manage every aspect of your projects, through Platform.sh’s
API documentation.
MORE DOCS, FOUND ELSEWHERE
There are many resources available outside of the documentation that will help
you work with Platform.sh, including demos, talks, and podcasts.
Check them out here.
To stay informed of all the latest Platform.sh news, join our newsletter.
Sign up for the newsletter
CONNECT WITH US
JOIN THE COMMUNITY
The Platform.sh community meets on both a Community forum and Slack for
questions and discussion.
Have an experiment you’d like to share? Looking for a way to contribute?
Join us on Slack
CONTRIBUTE
Feel free to open an issue or pull request for any of the repositories below, or
let us know on Slack if you find a problem we can help with:
* Documentation
* CLI
GET SUPPORT
If you’re experiencing issues with your projects, don’t hesitate to open a
support ticket.
IS THIS PAGE HELPFUL?
👍️ 👎️
❤️ Thanks for letting us know!
😞 Thanks for the feedback.
Suggest a change
Submit an issue
🙁 Couldn't process your feedback. Thanks for trying!
WE RESPECT YOUR PRIVACY
We use cookies to operate this website, improve usability, personalize your
experience, and improve our marketing. Your privacy is important to us, and we
will never sell your data.
Please note: If you disable functional cookies, our website will operate in a
reduced capacity.
Privacy Policy
Accept Cookies Reject All
Manage your cookie preferences
Your Opt Out Preference Signal is Honored
PRIVACY PREFERENCE CENTER
When you visit any website, it may store or retrieve information on your
browser, mostly in the form of cookies. This information might be about you,
your preferences or your device and is mostly used to make the site work as you
expect it to. The information does not usually directly identify you, but it can
give you a more personalized web experience. Because we respect your right to
privacy, you can choose not to allow some types of cookies. Click on the
different category headings to find out more and change our default settings.
However, blocking some types of cookies may impact your experience of the site
and the services we are able to offer.
Privacy Policy
Allow All
MANAGE CONSENT PREFERENCES
STRICTLY NECESSARY COOKIES
Always Active
These cookies are necessary for the website to function and cannot be switched
off in our systems. They are usually only set in response to actions made by you
which amount to a request for services, such as setting your privacy
preferences, logging in or filling in forms. You can set your browser to
block or alert you about these cookies, but some parts of the site will not then
work. These cookies do not store any personally identifiable information.
View Vendor Details
FUNCTIONAL COOKIES
Functional Cookies
These cookies enable the website to provide enhanced functionality and
personalisation. They may be set by us or by third party providers whose
services we have added to our pages. If you do not allow these cookies then
some or all of these services may not function properly.
View Vendor Details
PERFORMANCE & ANALYTIC COOKIES
Performance & Analytic Cookies
These cookies allow us to count visits and traffic sources so we can measure and
improve the performance of our site. They help us to know which pages are the
most and least popular and see how visitors move around the site. All
information these cookies collect is aggregated and therefore anonymous. If you
do not allow these cookies we will not know when you have visited our site, and
will not be able to monitor its performance.
View Vendor Details
SOCIAL MEDIA COOKIES
Social Media Cookies
These cookies are set by a range of social media services that we have added to
the site to enable you to share our content with your friends and networks. They
are capable of tracking your browser across other sites and building up a
profile of your interests. This may impact the content and messages you see on
other websites you visit. If you do not allow these cookies you may not be
able to use or see these sharing tools.
View Vendor Details
ADVERTISING COOKIES
Advertising Cookies
These cookies may be set through our site by our advertising partners. They may
be used by those companies to build a profile of your interests and show you
relevant adverts on other sites. They do not store directly personal
information, but are based on uniquely identifying your browser and internet
device. If you do not allow these cookies, you will experience less targeted
advertising.
View Vendor Details
Back Button
VENDORS LIST
Search Icon
Filter Icon
Clear
checkbox label label
Apply Cancel
Consent Leg.Interest
checkbox label label
checkbox label label
checkbox label label
Confirm My Choices