For coders TYPO3 Tech Corner

Integrating extensions in TYPO3 via Composer and Github

Integrating extensions in TYPO3 via Composer and Github

From time to time it happens that you want or need to integrate private TYPO3 extensions into a project. Reasons can be that the extension is chargeable or that you want to use your own extensions in several projects. As always, there are several ways to solve the task. It should also be noted that TYPO3 itself can be set up in two ways - classic or Composer based.

Composer based installation

The most convenient solution is to have a private Packagist access. For our Early Access programme we offer this service as part of the full sponsorship (it is not included in the Freelancer programme). 

Private Packagist

Packagist serves as the official point of contact for Composer commands and can be easily set up. There are two steps to the process: 
You need to add the custom repository to composer.json and set up "authenticate" to access your packages. The example below shows the configuration for in2code's early access programme.

1. Add the custom repository to composer.json:

composer config repositories.private-packagist composer <a href="https://in2code.repo.packagist.com/yourName/" target="_blank" rel="noreferrer">in2code.repo.packagist.com/yourName/</a>

2. Store the authentication in your global composer auth.json with the following command:Store the authentication in your global composer auth.json with the following command:

composer config --global --auth http-basic.in2code.repo. packagist.com token XXXXXXXyourToken>XXXX

Integration via Github repository

An alternative is to use a local repository or to integrate the Github repository. To do this, add an entry "respositories" to the composer.json of the project.

Example: Github Femanager Early Access Repository:

"repositories": [  {    "type": "vcs",    "url": "https://github.com/in2code-pro/femanager.git"  } ],

In this way, the Github repository is also queried when you then require the appropriate extension via Composer (in this example the TYPO3 extension femanager).

Another alternative is to use a local Git repository. Here you check out the extension yourself in a directory and integrate it via Composer.

Example:

"repositories": [  {    "type": "path",    "url": "/packages/*"  } ],

If we stick to the example of the extension "femanager", it has to be cloned into the directory below /packages/. Afterwards, the extension can be installed with "composer require".

Classic TYPO3 installation

In the classic installation, the source code of the extensions is located below typo3conf/ext/. 

There are two similar approaches: Export the Github repository to the appropriate directory below typo3conf/ext/. Here, for example, the git export command can be used to fetch the repository without the metadata (inside .git).

The alternative is the Git checkout directly into the typo3conf/ext/ directory. Please note that this also includes the metadata under (.git).

Stefan Busemann

Projects and products in the TYPO3 area?

Do you have questions about TYPO3 projects and products?

Our managing director Stefan Busemann will be glad to help you.

Stefan Busemann  |  Management & customer service

"Code faster, look at the time" - does this sound familiar to you?

How about time and respect for code quality? Working in a team? Automated tests?

Join us

Lesson cancellation - and now? New portal for the Bavarian school system.

For the Bavarian school system, we developed a new web app based on an existing but very outdated portal. The portal reports lesson cancellations throughout Bavaria and registered users are informed...

Go to news

SQL: Show all tables sorted by size in descending order

Lately I've been using the SQL command more often to find out which tables in the TYPO3 database are the largest. I've published the snippet once.

Go to news

TYPO3 12 with CKEditor 5: Styles in a single selection

If you set a link in the RTE in TYPO3, you may have to choose between different link classes, for example to create buttons in the frontend. What's new in TYPO3 12 is that you can select not just one...

Go to news

Null-Safe Operator in the TYPO3 area

With the introduction of PHP8, problems with undefined arrays or variables in general can arise in many places. Here are a few examples and simple solutions.

Go to news

Delete the first/last lines of a (SQL) file

There isn't much to say about the following commands. Sometimes it can be useful to delete the first (or last) X lines from a file. And if the file is too large to open with a conventional program, a...

Go to news

b13/container: Add and modify child elements in edit view

Unlike gridelements, you cannot manage the child elements in the B13 Container extension when you open the container in the editing view. I would be happy to show you how you can quickly install this...

Go to news