README

<img src="https://www.itzbund.de/SiteGlobals/Frontend/Images/logo.svg?__blob=normal&v=18" alt="Logo" width="300">

Jumpstart your GSB11 powered tenant development.

GSB11 Sitepackage Kickstarter

The GSB11 Sitepackage Kickstarter will help you to get started with GSB11 tenant development. After completing the steps below, you will have a local development environment up and running. You will be able to commit your tenant configuration and development to your tenant GitLab repository.

What do I get?

The purpose of the GSB11 Sitepackage Kickstarter is to provide developers with an easy entry into tenant development according to Option 2. See Tenant Factsheet.

Included after a successful setup are the core components of GSB11:

Basic configuration and core development components (gsb-core)
Accessibility improvements through a11y_backend
Enhanced user management and security adjustments (gsb-feusermanagement)
Prevention of phishing by removing metadata when uploading files (gsb-metadata-cleaner)
Display of favorites on the dashboard through gsb-widgets
the Accesable frontent without the federal style guide gsb_public_frontend

What is missing?

The frontend according to the federal style guide (gsb_privat_frontend) is not published and is only accessible to authorities. Access can be requested at https://produkt.gsb.bund.de/kontakt.

Tenant Factsheet

Please have a first look into the Tenant Factsheet upfront and use it as a reference for all questions regarding your tenant GSB11 project.

Prerequisites

You need a few things upfront:

one of the following supported operating systems
the following applications are installed
- git
- docker
- ddev
- php >=8.3 (optional)
- composer (optional)

Installation

NOTE

If you are developing on Windows, use ddev in WSL2 and enter the following commands in the Linux shell.

If you notice an error, please contribute your solution.

Follow the steps to set up a GSB11 website with this sitepackage as a composer root package.

Create GSB11 project dir
```
mkdir gsb11-mandant && cd $_
```

Create GSB11 ddev config

ddev config --php-version 8.3 --docroot .build/public --project-type typo3

Start local development environment
```
ddev start
```

Install dependencies in ddev

 ddev composer create-project itzbund/gsb-sitepackage -y

Install GSB11

 ddev exec cp vendor/typo3/cms-install/Resources/Private/FolderStructureTemplateFiles/root-htaccess .build/public/.htaccess && \
 ddev typo3 setup --force \
   --no-interaction \
   --server-type=apache \
   --driver=mysqli \
   --username=db \
   --password=db \
   --port=3306 \
   --host=db \
   --dbname=db \
   --admin-username=admin \
   --admin-user-password=Pas§§wor1 \
   --admin-email='' \
   --project-name="GSB11" \
   --create-site="https://gsb11-mandant.ddev.site"

NOTE

This configuration is used exclusively in the local development environment. The configuration is discarded in the deployment process! Please use a secure password

Install extensions

ddev exec vendor/bin/typo3 extension:setup

Launch project
```
ddev launch
```

you may need to configure $GLOBALS['TYPO3_CONF_VARS']['SYS']['trustedHostsPattern'] to gsb11-mandant.ddev.site

Login Backend

Visit https://gsb11-mandant.ddev.site/typo3 in your browser or use the
```
ddev launch /typo3
```
NOTE

You defined Username and Password in step 4 "Install GSB11".
Configure your GSB11 tenant 🚀

Additional details

For further information, please refer to the readmes of the extensions. A list of available extensions is included in the Mandate Factsheet.

Development

Explanations about caching in GSB11 and the CI/CD pipelines in development are stored in the GSB11 GitLab documentation project.

To successfully release a mandate version of GSB11, the site package must be developed with trunk-based development, with main being the standard branch. A merge into release triggers a stable release. The branches main and release are mandatory.

Contribute

As with TYPO3, we encourage you to join the project by submitting changes. Development of the GSB11 happens mainly in the GSB11 TYPO3 extensions.

To get started, have a look at our detailed contribution walkthrough.

itzbund / gsb-sitepackage

Maintainers

Details