Publish your extension¶
Follow these steps to release your extension publicly in the TYPO3 world:
– TYPO3 - Inspiring people to share
Git¶
Publish your source code on a public Git hosting platform.
The TYPO3 community currently uses GitHub, GitLab and Atlassian Bitbucket to host the Git repositories of their extensions.
Typically, the extension key is used for the repository name, but that is not necessary.
Advantages:
Contributors can add issues or make pull requests.
Documentation can be published in the official TYPO3 documentation by using a webhook (see below).
Packagist¶
Publish your extension on Packagist - the main Composer repository.
See their homepage for more details about the publishing process.
Depends on:
Public Git repository
Valid composer.json
Advantages:
Extension can be installed in a Composer based TYPO3 instance using
composer require
.All advantages of being listed in Packagist, for example
Extension can be updated easily with
composer update
TER¶
Publish your extension in the TYPO3 Extension Repository (TER) - the central storage for public TYPO3 extensions.
See page Publish your extension in the TER for more information about the publishing process and check out the TYPO3 community Q&A at page FAQ.
Depends on:
Extension key registered in TER
Advantages:
Extension can be installed in a legacy installation TYPO3 instance using the module Extensions.
All advantages of being listed in the TER, for example:
Easy finding of your extension
Reserved extension key in the TYPO3 world
The community can vote for your extension
Users can subscribe to notifications on new releases
Composer package is announced (optional)
Sponsoring link (optional)
Link to the documentation (optional)
Link to the source code (optional)
Link to the issue tracker (optional)
Documentation¶
Publish the documentation of your extension in the official TYPO3 documentation.
Please follow the instructions on page Register for docs.typo3.org to set up an appropriate webhook.
Depends on:
Public Git repository
Extension published in TER (optional). This is not mandatory, but makes the webhook approval easier for the TYPO3 Documentation Team.
Advantages:
Easily find your extension documentation, which serves as a good companion for getting started with your extension.
Crowdin¶
If you use language labels which should get translated in your extension
(typically in Resources/Private/Languages
),
you may want to configure the translation setup on https://crowdin.com.
Crowdin is the official translation server for TYPO3.
This is documented on Extension integration.