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

Table of Contents

• Overview
• Features Included
• What's Not Included
• Getting Started
• Simplified Installation via Install Script
• Prerequisites
• Installation Steps
• Additional Resources
• Contributing
• License

Overview

The GSB11 Sitepackage Kickstarter is a Composer root package that streamlines the setup of a local GSB11 tenant development environment. Follow the steps below to:

• Scaffold a new GSB11 project
• Launch a Docker-based development setup with DDEV
• Install and configure TYPO3 with core GSB11 extensions
• Begin customizing your tenant configuration

Features Included

After a successful setup, you'll have:

• Core GSB11 components (itzbund/gsb-core) with basic configuration
• Accessibility enhancements (itzbund/a11y_backend)
• Accessible frontend (without the official federal style guide) (itzbund/gsb_public_frontend)

What's Not Included

The following packages are not included in the base installation but can be installed thereafter using composer

• The official federal style-guide frontend (itzbund/gsb_privat_frontend) is private to authorities.\ You can request access at: https://produkt.gsb.bund.de/kontakt
• Consent Management (itzbund/gsb-consent)
• Improved user management & security (itzbund/gsb-feusermanagement)
• Metadata cleaning to help prevent phishing (itzbund/gsb-metadata-cleaner)
• Search powered by Solr (itzbund/gsb-solr)
• Dashboard favorites widget (itzbund/gsb-widgets)

Getting Started

Simplified Installation via Install Script

You can bootstrap your GSB11 tenant in one step by piping our install script to bash. This will download and run install.sh with sensible defaults:

# Using curl
curl -sL https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb-sitepackage-kickstarter/-/raw/main/install.sh?ref_type=heads | bash

# Or using wget
wget -qO- https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb-sitepackage-kickstarter/-/raw/main/install.sh?ref_type=heads | bash

[!TIP] Note: curl -sL https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb-sitepackage-kickstarter/-/raw/main/install.sh?ref_type=heads | bash -s -- -h will show the script's help menu (-h) without requiring you to download it first.

Prerequisites

Ensure you have the following installed on your machine:

Supported Operating Systems

• CentOS 9 / CentOS 10
• Debian 11 "Bullseye" / Debian 12 "Bookworm"
• Fedora 42
• macOS 15.5 "Sequoia"
• Ubuntu 22.04 "Jammy Jellyfish" / Ubuntu 24.04 "Noble Numbat"

Required Tools

• Git
• Docker
• DDEV (>= 1.24.2)

[!IMPORTANT] Windows Users: Run DDEV inside WSL2 and execute commands in the Linux shell.

Browser Compatibility

GSB 11 is optimized for use in Google Chrome, Microsoft Edge, Mozilla Firefox, and Apple Safari.

Internet Explorer is not supported by GSB 11. When using this browser, there may be limitations in functionality as well as display errors. Limitations in interactive functions, form processing, security-related mechanisms, as well as in the correct display of layout and design elements are possible.

Installation Steps

1. Create project directory

mkdir gsb11-tenant && cd $_

1. Initialize DDEV configuration

ddev config --php-version 8.3 --docroot .build/public --project-type typo3 --webimage-extra-packages "cron,exiftool,qpdf,php8.3-opentelemetry,php8.3-grpc"

1. Start DDEV

ddev start

1. Install the sitepackage

ddev composer create-project --remove-vcs itzbund/gsb-sitepackage

1. restart to apply enviroment

ddev restart

1. Setup TYPO3 & 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' \
    --project-name="GSB11" \
    --admin-username='admin' \
    --admin-user-password='§Chang3Me§' \
    --admin-email=''

[!WARNING] Security Note: This password is only for local development. Use a strong, secure password in production.

1. Import initial database and update schema

ddev import-db --file=.ddev/initial-setup/mysql-db.sql --no-drop && \
ddev typo3 database:updateschema

1. Enable all extensions

ddev exec vendor/bin/typo3 extension:setup

1. Copy placeholder image

ddev exec mkdir -p ".build/public/fileadmin/user_upload" && \
ddev exec chmod -R 2775 ".build/public/fileadmin" && \
ddev exec cp Resources/Public/Images/placeholder_image.jpg ".build/public/fileadmin/user_upload/placeholder_image.jpg"

1. Launch the site

ddev launch

Alternatively, visit: gsb11-tenant.ddev.site

1. Access the TYPO3 backend

ddev launch /typo3

Use the admin credentials from step 6. \ Alternatively, visit: gsb11-tenant.ddev.site/typo3

1. Start customizing! 🚀

Additional Resources

• Tenant Factsheet:\ https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb-sitepackage-kickstarter/-/blob/main/FACTSHEET.md
• Extension READMEs: See each extension's own README for detailed usage.
• CI/CD & Caching Docs: Available in the main GSB11 GitLab project.

Contributing

We welcome your contributions! Please follow our Contribution Walkthrough to get started.

License

This project is licensed under the GPL-3.0-or-later.