https://github.com/typo3/surf

Easy and powerful PHP deployment tool
https://github.com/typo3/surf

deployment php surf tool typo3

Last synced: 13 days ago
JSON representation

Easy and powerful PHP deployment tool

• Host: GitHub
• URL: https://github.com/typo3/surf
• Owner: TYPO3
• License: gpl-3.0
• Created: 2016-01-11T14:36:37.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2025-02-17T13:34:27.000Z (2 months ago)
• Last Synced: 2025-04-11T12:19:18.613Z (16 days ago)
• Topics: deployment, php, surf, tool, typo3
• Language: PHP
• Homepage: https://docs.typo3.org/other/typo3/surf/master/en-us/
• Size: 3.73 MB
• Stars: 99
• Watchers: 14
• Forks: 54
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Latest Stable Version](https://poser.pugx.org/typo3/surf/v/stable.svg)](https://packagist.org/packages/TYPO3/Surf)

[![Total Downloads](https://poser.pugx.org/typo3/surf/downloads.svg)](https://packagist.org/packages/TYPO3/Surf)

[![Monthly Downloads](https://poser.pugx.org/typo3/surf/d/monthly)](https://packagist.org/packages/TYPO3/Surf)

[![Tests](https://github.com/TYPO3/Surf/actions/workflows/tests.yaml/badge.svg)](https://github.com/TYPO3/Surf/actions/workflows/tests.yaml)

[![Coverage Status](https://img.shields.io/coveralls/TYPO3/Surf/main.svg?style=flat-square)](https://coveralls.io/github/TYPO3/Surf?branch=main)

# Surf

Surf package is an automated deployment tool. It is best used but by far not limited to deploy TYPO3 CMS and Flow applications.

It's inspired by some features of Capistrano concerning the Git workflow.

Some features of the Surf package:

* Remote checkout of Git repositories with submodules

* Flexible, declarative configuration of deployments

* Multi-node (Cloud), multi-application (i.e. separated frontend and backend) deployments

* Create custom tasks with a few lines

* Simulate deployments with a dry run

* Pre-defined workflows for TYPO3, Flow, Neos and Laravel deployments

## Documentation

For further information please read the documentation https://docs.typo3.org/other/typo3/surf/main/en-us/.

### Contributing to the documentation

You can simply edit or add a .rst file in the `Documentation` folder on GitHub and create a pull request.

The online documentation will automatically update after changes to the main branch.

To preview the documentation locally, please follow this [guide](https://github.com/t3docs/docker-render-documentation).

The documentation was set up according to the [TYPO3 documentation guide](https://docs.typo3.org/typo3cms/RenderTYPO3DocumentationGuide/Index.html).

|                  | URL                                                 |

|------------------|-----------------------------------------------------|

| **Repository:**  | https://github.com/TYPO3/Surf                       |

| **Read online:** | https://docs.typo3.org/other/typo3/surf/main/en-us/ |

| **Packagist:**   | https://packagist.org/packages/typo3/surf           |