Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
[FEATURE] Add chapter on custom TER (#1110)
* [FEATURE] Add chapter on custom TER See Core Feature 92457 See #1082 * [TASK] Mention Classic/Composer Mode Also fix capitalization of "Composer". * [TASK] Use ter remote name in example Co-authored-by: Mathias Brodala <mbrodala@pagemachine.de>
- Loading branch information
1 parent
af4e09b
commit 352f753
Showing
2 changed files
with
64 additions
and
0 deletions.
There are no files selected for viewing
56 changes: 56 additions & 0 deletions
56
Documentation/ExtensionArchitecture/CustomExtensionRepository/Index.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
.. include:: /Includes.rst.txt | ||
|
||
|
||
.. _custom-extension-repository: | ||
|
||
=========================== | ||
Custom Extension Repository | ||
=========================== | ||
|
||
.. note:: | ||
|
||
This section is only relevant for Classic Mode installations, | ||
as Composer Mode installations use the download functionality | ||
of Composer. | ||
|
||
TYPO3 provides functionality that connects to a different repository type | ||
than the "official" TER_ (TYPO3 Extension Repository) to download third-party extensions. | ||
The API is called "Extension Remotes". These remotes are adapters that allow | ||
fetching a list of extensions via the :php:`ListableRemoteInterface` or downloading | ||
an extension via the :php:`ExtensionDownloaderRemoteInterface`. | ||
|
||
It is possible to add new remotes, disable registered remotes | ||
or change the default remote. | ||
|
||
Custom remote configuration can be added in the | ||
:file:`Configuration/Services.yaml` of the corresponding extension. | ||
|
||
.. code-block:: yaml | ||
extension.remote.myremote: | ||
class: 'TYPO3\CMS\Extensionmanager\Remote\TerExtensionRemote' | ||
arguments: | ||
$identifier: 'myremote' | ||
$options: | ||
remoteBase: 'https://my_own_remote/' | ||
tags: | ||
- name: 'extension.remote' | ||
default: true | ||
Using :yaml:`default: true`, "myremote" will be used as the default remote. | ||
Setting :yaml:`default: true` only works if the defined service | ||
implements :php:`ListableRemoteInterface`. | ||
|
||
Please note that :php:`Vendor\SitePackage\Remote\MyRemote` must implement | ||
:php:`ExtensionDownloaderRemoteInterface` to be registered as remote. | ||
|
||
To disable an already registered remote, :yaml:`enabled: false` can be set. | ||
|
||
.. code-block:: yaml | ||
extension.remote.ter: | ||
tags: | ||
- name: 'extension.remote' | ||
enabled: false | ||
.. _TER: https://extensions.typo3.org/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters