From 61cf149500593f91f747133e2052599e9e4fdd24 Mon Sep 17 00:00:00 2001 From: fkaminski Date: Mon, 4 Nov 2024 16:45:16 +0100 Subject: [PATCH 01/11] DDEV Guide - Add Contao Demo Installation Info --- docs/manual/guides/local-installation/ddev.de.md | 9 +++++++++ docs/manual/guides/local-installation/ddev.en.md | 9 +++++++++ 2 files changed, 18 insertions(+) diff --git a/docs/manual/guides/local-installation/ddev.de.md b/docs/manual/guides/local-installation/ddev.de.md index 8f1b6928d..85d92345b 100644 --- a/docs/manual/guides/local-installation/ddev.de.md +++ b/docs/manual/guides/local-installation/ddev.de.md @@ -78,6 +78,15 @@ Mit `ddev launch contao` kommst du direkt zur Administration. {{% /notice %}} + +{{% notice tip %}} + +Die [Contao Demo Webseite](https://demo.contao.org/) wird für die aktuell unterstützten Contao-Versionen gepflegt und kann optional +über Composer installiert werden. Hier findest du Informationen zur [Installation der Contao Demo](https://github.com/contao/contao-demo). + +{{% /notice %}} + + ## Zusatz Informationen `ddev start` startet das Projekt, `ddev stop` beendet es. Stelle vorher sicher, dass du in den Projektordner gewechselt hast. diff --git a/docs/manual/guides/local-installation/ddev.en.md b/docs/manual/guides/local-installation/ddev.en.md index 756ce865e..0a28161aa 100644 --- a/docs/manual/guides/local-installation/ddev.en.md +++ b/docs/manual/guides/local-installation/ddev.en.md @@ -80,6 +80,15 @@ With `ddev launch contao` you get directly to the administration. The `ddev` binary is not available in the container, so first switch to the host console with `exit`. + +{{% notice tip %}} + +The [Contao Demo Website](https://demo.contao.org/) is maintained for the currently supported Contao versions and can be optionally +be installed via Composer. Here you can find information about the [Installation of the Contao Demo](https://github.com/contao/contao-demo). + +{{% /notice %}} + + ## Additional information `ddev start` starts the project, `ddev stop` ends it. Make sure beforehand that you have changed to the project folder. From e7822a12172008d8e170f028a1444c9b63ec661a Mon Sep 17 00:00:00 2001 From: Franko Date: Mon, 4 Nov 2024 16:55:34 +0100 Subject: [PATCH 02/11] Update docs/manual/guides/local-installation/ddev.de.md Co-authored-by: Fritz Michael Gschwantner --- docs/manual/guides/local-installation/ddev.de.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/manual/guides/local-installation/ddev.de.md b/docs/manual/guides/local-installation/ddev.de.md index 85d92345b..b9a9f6951 100644 --- a/docs/manual/guides/local-installation/ddev.de.md +++ b/docs/manual/guides/local-installation/ddev.de.md @@ -80,10 +80,8 @@ Mit `ddev launch contao` kommst du direkt zur Administration. {{% notice tip %}} - Die [Contao Demo Webseite](https://demo.contao.org/) wird für die aktuell unterstützten Contao-Versionen gepflegt und kann optional über Composer installiert werden. Hier findest du Informationen zur [Installation der Contao Demo](https://github.com/contao/contao-demo). - {{% /notice %}} From 3ee5e2e64ca302ac1c638e7e7a5a0f96cf04dd75 Mon Sep 17 00:00:00 2001 From: Franko Date: Mon, 4 Nov 2024 16:55:39 +0100 Subject: [PATCH 03/11] Update docs/manual/guides/local-installation/ddev.en.md Co-authored-by: Fritz Michael Gschwantner --- docs/manual/guides/local-installation/ddev.en.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/manual/guides/local-installation/ddev.en.md b/docs/manual/guides/local-installation/ddev.en.md index 0a28161aa..31c5a6471 100644 --- a/docs/manual/guides/local-installation/ddev.en.md +++ b/docs/manual/guides/local-installation/ddev.en.md @@ -82,10 +82,8 @@ The `ddev` binary is not available in the container, so first switch to the host {{% notice tip %}} - The [Contao Demo Website](https://demo.contao.org/) is maintained for the currently supported Contao versions and can be optionally be installed via Composer. Here you can find information about the [Installation of the Contao Demo](https://github.com/contao/contao-demo). - {{% /notice %}} From e64c7c274c6b1fe6c53dcf66f88af6dc904324dd Mon Sep 17 00:00:00 2001 From: fkaminski Date: Mon, 4 Nov 2024 17:11:30 +0100 Subject: [PATCH 04/11] Move comment up --- docs/manual/guides/local-installation/ddev.de.md | 13 +++++-------- docs/manual/guides/local-installation/ddev.en.md | 13 +++++-------- 2 files changed, 10 insertions(+), 16 deletions(-) diff --git a/docs/manual/guides/local-installation/ddev.de.md b/docs/manual/guides/local-installation/ddev.de.md index 85d92345b..e2519fdf1 100644 --- a/docs/manual/guides/local-installation/ddev.de.md +++ b/docs/manual/guides/local-installation/ddev.de.md @@ -30,6 +30,11 @@ DDEV ist für alle Plattformen verfügbar, für die Installation deiner Plattfor Öffne die Konsole deiner Wahl, erstelle das gewünschte Verzeichnis und wechsle danach in ebendieses. Der Verzeichnisname spiegelt den späteren Projekt Hostnamen. Du kannst dies jedoch zusätzlich [konfigurieren](https://ddev.readthedocs.io/en/latest/users/extend/additional-hostnames/). +{{% notice tip %}} +Die [Contao Demo Webseite](https://demo.contao.org/) wird für die aktuell unterstützten Contao-Versionen gepflegt und kann optional +über Composer installiert werden. Hier findest du Informationen zur [Installation der Contao Demo](https://github.com/contao/contao-demo). +{{% /notice %}} + ```shell mkdir -p ~/Projekte/contao/contao-ddev && cd ~/Projekte/contao/contao-ddev ``` @@ -79,14 +84,6 @@ Mit `ddev launch contao` kommst du direkt zur Administration. {{% /notice %}} -{{% notice tip %}} - -Die [Contao Demo Webseite](https://demo.contao.org/) wird für die aktuell unterstützten Contao-Versionen gepflegt und kann optional -über Composer installiert werden. Hier findest du Informationen zur [Installation der Contao Demo](https://github.com/contao/contao-demo). - -{{% /notice %}} - - ## Zusatz Informationen `ddev start` startet das Projekt, `ddev stop` beendet es. Stelle vorher sicher, dass du in den Projektordner gewechselt hast. diff --git a/docs/manual/guides/local-installation/ddev.en.md b/docs/manual/guides/local-installation/ddev.en.md index 0a28161aa..d1ce35907 100644 --- a/docs/manual/guides/local-installation/ddev.en.md +++ b/docs/manual/guides/local-installation/ddev.en.md @@ -30,6 +30,11 @@ DDEV is available for all platforms, please refer to the [DDEV documentation](ht Open the console of your choice, create the desired directory and then change to it. The directory name reflects the subsequent project hostname. However, you can [configure this](https://ddev.readthedocs.io/en/latest/users/extend/additional-hostnames/) additionally. +{{% notice tip %}} +The [Contao Demo Website](https://demo.contao.org/) is maintained for the currently supported Contao versions and can be optionally +be installed via Composer. Here you can find information about the [Installation of the Contao Demo](https://github.com/contao/contao-demo). +{{% /notice %}} + ```shell mkdir -p ~/projects/contao/contao-ddev && cd ~/projects/contao/contao-ddev ``` @@ -81,14 +86,6 @@ With `ddev launch contao` you get directly to the administration. The `ddev` binary is not available in the container, so first switch to the host console with `exit`. -{{% notice tip %}} - -The [Contao Demo Website](https://demo.contao.org/) is maintained for the currently supported Contao versions and can be optionally -be installed via Composer. Here you can find information about the [Installation of the Contao Demo](https://github.com/contao/contao-demo). - -{{% /notice %}} - - ## Additional information `ddev start` starts the project, `ddev stop` ends it. Make sure beforehand that you have changed to the project folder. From 9d281894e88de18510acfcb6a600004bab81af32 Mon Sep 17 00:00:00 2001 From: fkaminski Date: Mon, 4 Nov 2024 17:26:33 +0100 Subject: [PATCH 05/11] Change level up --- docs/manual/guides/local-installation/ddev.de.md | 4 ++-- docs/manual/guides/local-installation/ddev.en.md | 3 +-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/manual/guides/local-installation/ddev.de.md b/docs/manual/guides/local-installation/ddev.de.md index e2519fdf1..50006502b 100644 --- a/docs/manual/guides/local-installation/ddev.de.md +++ b/docs/manual/guides/local-installation/ddev.de.md @@ -28,13 +28,13 @@ DDEV ist für alle Plattformen verfügbar, für die Installation deiner Plattfor ## Projekt erstellen -Öffne die Konsole deiner Wahl, erstelle das gewünschte Verzeichnis und wechsle danach in ebendieses. Der Verzeichnisname spiegelt den späteren Projekt Hostnamen. Du kannst dies jedoch zusätzlich [konfigurieren](https://ddev.readthedocs.io/en/latest/users/extend/additional-hostnames/). - {{% notice tip %}} Die [Contao Demo Webseite](https://demo.contao.org/) wird für die aktuell unterstützten Contao-Versionen gepflegt und kann optional über Composer installiert werden. Hier findest du Informationen zur [Installation der Contao Demo](https://github.com/contao/contao-demo). {{% /notice %}} +Öffne die Konsole deiner Wahl, erstelle das gewünschte Verzeichnis und wechsle danach in ebendieses. Der Verzeichnisname spiegelt den späteren Projekt Hostnamen. Du kannst dies jedoch zusätzlich [konfigurieren](https://ddev.readthedocs.io/en/latest/users/extend/additional-hostnames/). + ```shell mkdir -p ~/Projekte/contao/contao-ddev && cd ~/Projekte/contao/contao-ddev ``` diff --git a/docs/manual/guides/local-installation/ddev.en.md b/docs/manual/guides/local-installation/ddev.en.md index 8bf9d3437..629835d3e 100644 --- a/docs/manual/guides/local-installation/ddev.en.md +++ b/docs/manual/guides/local-installation/ddev.en.md @@ -28,13 +28,12 @@ DDEV is available for all platforms, please refer to the [DDEV documentation](ht ## Create project -Open the console of your choice, create the desired directory and then change to it. The directory name reflects the subsequent project hostname. However, you can [configure this](https://ddev.readthedocs.io/en/latest/users/extend/additional-hostnames/) additionally. - {{% notice tip %}} The [Contao Demo Website](https://demo.contao.org/) is maintained for the currently supported Contao versions and can be optionally be installed via Composer. Here you can find information about the [Installation of the Contao Demo](https://github.com/contao/contao-demo). {{% /notice %}} +Open the console of your choice, create the desired directory and then change to it. The directory name reflects the subsequent project hostname. However, you can [configure this](https://ddev.readthedocs.io/en/latest/users/extend/additional-hostnames/) additionally. ```shell mkdir -p ~/projects/contao/contao-ddev && cd ~/projects/contao/contao-ddev From eb06e44f29a556525b18b9df25620a534d95451b Mon Sep 17 00:00:00 2001 From: fkaminski Date: Tue, 5 Nov 2024 08:46:54 +0100 Subject: [PATCH 06/11] Move tip --- docs/manual/guides/local-installation/ddev.de.md | 10 +++++----- docs/manual/guides/local-installation/ddev.en.md | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/manual/guides/local-installation/ddev.de.md b/docs/manual/guides/local-installation/ddev.de.md index 50006502b..6bb93f534 100644 --- a/docs/manual/guides/local-installation/ddev.de.md +++ b/docs/manual/guides/local-installation/ddev.de.md @@ -28,11 +28,6 @@ DDEV ist für alle Plattformen verfügbar, für die Installation deiner Plattfor ## Projekt erstellen -{{% notice tip %}} -Die [Contao Demo Webseite](https://demo.contao.org/) wird für die aktuell unterstützten Contao-Versionen gepflegt und kann optional -über Composer installiert werden. Hier findest du Informationen zur [Installation der Contao Demo](https://github.com/contao/contao-demo). -{{% /notice %}} - Öffne die Konsole deiner Wahl, erstelle das gewünschte Verzeichnis und wechsle danach in ebendieses. Der Verzeichnisname spiegelt den späteren Projekt Hostnamen. Du kannst dies jedoch zusätzlich [konfigurieren](https://ddev.readthedocs.io/en/latest/users/extend/additional-hostnames/). ```shell @@ -51,6 +46,11 @@ Contao 5.3 installieren: ddev composer create contao/managed-edition:5.3 ``` +{{% notice tip %}} +Die [Contao Demo Webseite](https://demo.contao.org/) wird für die aktuell unterstützten Contao-Versionen gepflegt und kann optional +über Composer installiert werden. Hier findest du Informationen zur [Installation der Contao Demo](https://github.com/contao/contao-demo). +{{% /notice %}} + Nach der Installation müssen die Datenbankzugangsdaten in die `.env.local` eingetragen werden. In diesem Zug richten wir auch direkt Mailpit ein. ```env diff --git a/docs/manual/guides/local-installation/ddev.en.md b/docs/manual/guides/local-installation/ddev.en.md index 629835d3e..641e68d44 100644 --- a/docs/manual/guides/local-installation/ddev.en.md +++ b/docs/manual/guides/local-installation/ddev.en.md @@ -28,11 +28,6 @@ DDEV is available for all platforms, please refer to the [DDEV documentation](ht ## Create project -{{% notice tip %}} -The [Contao Demo Website](https://demo.contao.org/) is maintained for the currently supported Contao versions and can be optionally -be installed via Composer. Here you can find information about the [Installation of the Contao Demo](https://github.com/contao/contao-demo). -{{% /notice %}} - Open the console of your choice, create the desired directory and then change to it. The directory name reflects the subsequent project hostname. However, you can [configure this](https://ddev.readthedocs.io/en/latest/users/extend/additional-hostnames/) additionally. ```shell @@ -51,6 +46,11 @@ Install Contao 5.3: ddev composer create contao/managed-edition:5.3 ``` +{{% notice tip %}} +The [Contao Demo Website](https://demo.contao.org/) is maintained for the currently supported Contao versions and can be optionally +be installed via Composer. Here you can find information about the [Installation of the Contao Demo](https://github.com/contao/contao-demo). +{{% /notice %}} + After installation, the database access data must be entered in the `.env.local`. At the same time, we also set up Mailpit directly. ```env From 9fde0e21671322792bde75598c720437da2b75a1 Mon Sep 17 00:00:00 2001 From: fkaminski Date: Wed, 6 Nov 2024 12:54:25 +0100 Subject: [PATCH 07/11] Seperate tabs concerning installing via composer and contao manager --- .../guides/local-installation/ddev.de.md | 88 +++++++++++++------ .../guides/local-installation/ddev.en.md | 86 ++++++++++++------ 2 files changed, 123 insertions(+), 51 deletions(-) diff --git a/docs/manual/guides/local-installation/ddev.de.md b/docs/manual/guides/local-installation/ddev.de.md index 6bb93f534..3d5181c0d 100644 --- a/docs/manual/guides/local-installation/ddev.de.md +++ b/docs/manual/guides/local-installation/ddev.de.md @@ -26,18 +26,28 @@ mehr Informationen zur Installation dieser Programme durchlesen. DDEV ist für alle Plattformen verfügbar, für die Installation deiner Plattform schau bitte in der [DDEV Dokumentation](https://ddev.readthedocs.io/en/stable/users/install/ddev-installation/) nach. + ## Projekt erstellen +{{% notice tip %}} +Die [Contao Demo Webseite](https://demo.contao.org/) wird für die aktuell unterstützten Contao-Versionen gepflegt und kann [optional +installiert](https://github.com/contao/contao-demo) werden. Über den Contao Manager kannst du dazu, bei einer Erstinstalltion, einfach diese +Option auswählen. +{{% /notice %}} + +{{< tabs groupId="Example">}} + +{{% tab name="Composer" %}} Öffne die Konsole deiner Wahl, erstelle das gewünschte Verzeichnis und wechsle danach in ebendieses. Der Verzeichnisname spiegelt den späteren Projekt Hostnamen. Du kannst dies jedoch zusätzlich [konfigurieren](https://ddev.readthedocs.io/en/latest/users/extend/additional-hostnames/). ```shell -mkdir -p ~/Projekte/contao/contao-ddev && cd ~/Projekte/contao/contao-ddev +mkdir contao && cd contao ``` DDEV-Konfiguration anlegen mit: ```shell -ddev config --project-type=php --docroot=public --webserver-type=apache-fpm --php-version=8.2 --create-docroot --timezone=Europe/Berlin +ddev config --project-type=php --docroot=public --webserver-type=apache-fpm --php-version=8.2 ``` Contao 5.3 installieren: @@ -46,55 +56,83 @@ Contao 5.3 installieren: ddev composer create contao/managed-edition:5.3 ``` -{{% notice tip %}} -Die [Contao Demo Webseite](https://demo.contao.org/) wird für die aktuell unterstützten Contao-Versionen gepflegt und kann optional -über Composer installiert werden. Hier findest du Informationen zur [Installation der Contao Demo](https://github.com/contao/contao-demo). -{{% /notice %}} +Nach der Installation müssen die Datenbankzugangsdaten in die `.env.local` eingetragen werden. In diesem Zug richten wir auch direkt +[Mailpit](https://ddev.readthedocs.io/en/stable/users/usage/developer-tools/#email-capture-and-review-mailpit) ein. -Nach der Installation müssen die Datenbankzugangsdaten in die `.env.local` eingetragen werden. In diesem Zug richten wir auch direkt Mailpit ein. - -```env -APP_ENV=prod -DATABASE_URL=mysql://db:db@db:3306/db -MAILER_DSN=smtp://localhost:1025 +```shell +ddev dotenv set .env.local --database-url=mysql://db:db@db:3306/db --mailer-dsn=smtp://localhost:1025 ``` Im Anschluss die Datenbank anlegen: ```shell -ddev exec "bin/console contao:migrate" +ddev exec contao-console contao:migrate --no-interaction ``` -Backend-User anlegen: +Backend-User anlegen (Administrator): ```shell -ddev exec "bin/console contao:user:create" +ddev exec contao-console contao:user:create --username=admin --name=Administrator --email=admin@example.com --language=de --password=Password123 --admin ``` -Projekt im Browser aufrufen: +Die Contao Administration im Browser aufrufen: ```shell -ddev launch +ddev launch contao ``` -{{% notice note %}} +{{% /tab %}} -Mit `ddev launch contao` kommst du direkt zur Administration. +{{% tab name="Contao Manager" %}} -{{% /notice %}} +Öffne die Konsole deiner Wahl, erstelle das gewünschte Verzeichnis und wechsle danach in ebendieses. Der Verzeichnisname spiegelt den späteren Projekt Hostnamen. Du kannst dies jedoch zusätzlich [konfigurieren](https://ddev.readthedocs.io/en/latest/users/extend/additional-hostnames/). + +```shell +mkdir contao && cd contao +``` + +DDEV-Konfiguration anlegen mit: + +```shell +ddev config --project-type=php --docroot=public --webserver-type=apache-fpm --php-version=8.2 +``` + +Nach der Installation müssen die Datenbankzugangsdaten in die `.env.local` eingetragen werden. In diesem Zug richten wir auch direkt +[Mailpit](https://ddev.readthedocs.io/en/stable/users/usage/developer-tools/#email-capture-and-review-mailpit) ein. + +```shell +ddev dotenv set .env.local --database-url=mysql://db:db@db:3306/db --mailer-dsn=smtp://localhost:1025 +``` + +Den Contao Manager herunterladen, umbenennen (.php) und in das `public` Verzeichnis kopieren. Du kannst dazu auch `wget` oder `curl` nutzen. + +```shell +ddev start +ddev exec "wget -O public/contao-manager.phar.php https://download.contao.org/contao-manager/stable/contao-manager.phar" +``` + +Den Contao Manager aufrufen und den Anweisungen folgen. + +```shell +ddev launch contao-manager.phar.php +``` + +{{% /tab %}} + +{{< /tabs >}} ## Zusatz Informationen -`ddev start` startet das Projekt, `ddev stop` beendet es. Stelle vorher sicher, dass du in den Projektordner gewechselt hast. +- `ddev start` startet das Projekt, `ddev stop` beendet es. Stelle vorher sicher, dass du in den Projektordner gewechselt hast. -`ddev poweroff` kann aus jedem Verzeichnis heraus alle gestarteten Projekte/Container stoppen. +- `ddev poweroff` kann aus jedem Verzeichnis heraus alle gestarteten Projekte/Container stoppen. -Mit `ddev ssh` wechselst du in die Shell des Containers und kannst auf der Konsole arbeiten. Die `ddev` Binary steht im Container nicht zur Verfügung, also erst mit `exit` auf die Host-Konsole wechseln. +- Mit `ddev ssh` wechselst du in die Shell des Containers und kannst auf der Konsole arbeiten. Die `ddev` Binary steht im Container nicht zur Verfügung, also erst mit `exit` auf die Host-Konsole wechseln. -`ddev describe` gibt eine Übersicht der Services, die im Projekt zur Verfügung stehen und wie du sie erreichst. +- `ddev describe` gibt eine Übersicht der Services, die im Projekt zur Verfügung stehen und wie du sie erreichst. -`ddev xdebug on` startet XDebug. [Informationen zum IDE-Setup](https://ddev.readthedocs.io/en/latest/users/debugging-profiling/step-debugging/#ide-setup) +- `ddev xdebug on` startet XDebug. [Informationen zum IDE-Setup](https://ddev.readthedocs.io/en/latest/users/debugging-profiling/step-debugging/#ide-setup) {{% notice note %}} Falls du als Windows Anwender die »Git Bash« als Konsole benutzt, kann es, abhängig von deiner »Git für Windows« Konfiguration, notwendig sein das Kommando `winpty` voran zu stellen (z. B.: `winpty ddev ssh`). diff --git a/docs/manual/guides/local-installation/ddev.en.md b/docs/manual/guides/local-installation/ddev.en.md index 641e68d44..3aa0cf9fc 100644 --- a/docs/manual/guides/local-installation/ddev.en.md +++ b/docs/manual/guides/local-installation/ddev.en.md @@ -28,16 +28,24 @@ DDEV is available for all platforms, please refer to the [DDEV documentation](ht ## Create project +{{% notice tip %}} +The [Contao demo website](https://demo.contao.org/) is maintained for the currently supported Contao versions and can be [optionally +installed](https://github.com/contao/contao-demo). Via the Contao Manager you can simply select this option during the first installation. +{{% /notice %}} + +{{< tabs groupId="Example">}} + +{{% tab name="Composer" %}} Open the console of your choice, create the desired directory and then change to it. The directory name reflects the subsequent project hostname. However, you can [configure this](https://ddev.readthedocs.io/en/latest/users/extend/additional-hostnames/) additionally. ```shell -mkdir -p ~/projects/contao/contao-ddev && cd ~/projects/contao/contao-ddev +mkdir contao && cd contao ``` Create the DDEV configuration with: ```shell -ddev config --project-type=php --docroot=public --webserver-type=apache-fpm --php-version=8.2 --create-docroot --timezone=Europe/Berlin +ddev config --project-type=php --docroot=public --webserver-type=apache-fpm --php-version=8.2 ``` Install Contao 5.3: @@ -46,57 +54,83 @@ Install Contao 5.3: ddev composer create contao/managed-edition:5.3 ``` -{{% notice tip %}} -The [Contao Demo Website](https://demo.contao.org/) is maintained for the currently supported Contao versions and can be optionally -be installed via Composer. Here you can find information about the [Installation of the Contao Demo](https://github.com/contao/contao-demo). -{{% /notice %}} +After installation, the database access data must be entered in the .env.local. At the same time, we also set up +[Mailpit](https://ddev.readthedocs.io/en/stable/users/usage/developer-tools/#email-capture-and-review-mailpit) directly. -After installation, the database access data must be entered in the `.env.local`. At the same time, we also set up Mailpit directly. - -```env -APP_ENV=prod -DATABASE_URL=mysql://db:db@db:3306/db -MAILER_DSN=smtp://localhost:1025 +```shell +ddev dotenv set .env.local --database-url=mysql://db:db@db:3306/db --mailer-dsn=smtp://localhost:1025 ``` Then create the database: ```shell -ddev exec "bin/console contao:migrate" +ddev exec contao-console contao:migrate --no-interaction ``` -Create backend user: +Create backend user (Administrator): ```shell -ddev exec "bin/console contao:user:create" +ddev exec contao-console contao:user:create --username=admin --name=Administrator --email=admin@example.com --language=en --password=Password123 --admin ``` -Call up the project in the browser: +Call up the Administration in the browser: ```shell -ddev launch +ddev launch contao ``` -{{% notice note %}} +{{% /tab %}} -With `ddev launch contao` you get directly to the administration. +{{% tab name="Contao Manager" %}} -{{% /notice %}} +Open the console of your choice, create the desired directory and then change to it. The directory name reflects the subsequent project hostname. However, you can [configure this](https://ddev.readthedocs.io/en/latest/users/extend/additional-hostnames/) additionally. + +```shell +mkdir contao && cd contao +``` + +Create the DDEV configuration with: + +```shell +ddev config --project-type=php --docroot=public --webserver-type=apache-fpm --php-version=8.2 +``` + +After installation, the database access data must be entered in the .env.local. At the same time, we also set up +[Mailpit](https://ddev.readthedocs.io/en/stable/users/usage/developer-tools/#email-capture-and-review-mailpit) directly. + +```shell +ddev dotenv set .env.local --database-url=mysql://db:db@db:3306/db --mailer-dsn=smtp://localhost:1025 +``` + +Download the Contao Manager, rename it (.php) and copy it into the `public` directory. You can also use `wget` or `curl` to do this. + +```shell +ddev start +ddev exec "wget -O public/contao-manager.phar.php https://download.contao.org/contao-manager/stable/contao-manager.phar" +``` + +Open the Contao Manager and follow the instructions: + +```shell +ddev launch contao-manager.phar.php +``` + +{{% /tab %}} -The `ddev` binary is not available in the container, so first switch to the host console with `exit`. +{{< /tabs >}} ## Additional information -`ddev start` starts the project, `ddev stop` ends it. Make sure beforehand that you have changed to the project folder. +- `ddev start` starts the project, `ddev stop` ends it. Make sure beforehand that you have changed to the project folder. -`ddev poweroff` can stop all started projects/containers from any directory. +- `ddev poweroff` can stop all started projects/containers from any directory. -With `ddev ssh` you can switch to the shell of the container and work on the console. The `ddev` binary is not available in the container, so first switch to the host console with `exit`. +- With `ddev ssh` you can switch to the shell of the container and work on the console. The `ddev` binary is not available in the container, so first switch to the host console with `exit`. -`ddev describe` gives an overview of the services available in the project and how to access them. +- `ddev describe` gives an overview of the services available in the project and how to access them. -`ddev xdebug on` starts XDebug. [Information about the IDE setup](https://ddev.readthedocs.io/en/latest/users/debugging-profiling/step-debugging/#ide-setup) +- `ddev xdebug on` starts XDebug. [Information about the IDE setup](https://ddev.readthedocs.io/en/latest/users/debugging-profiling/step-debugging/#ide-setup) {{% notice note %}} If you are a Windows user using the "Git Bash" as a console, it may be necessary, depending on your "Git for Windows" configuration, to prepend the command `winpty` (e.g.: `winpty ddev ssh`). From fce30ae21fbedf87be16b7ed966c787f75d362a3 Mon Sep 17 00:00:00 2001 From: fkaminski Date: Thu, 7 Nov 2024 14:48:03 +0100 Subject: [PATCH 08/11] Some typo and remove password argument --- docs/manual/guides/local-installation/ddev.en.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/manual/guides/local-installation/ddev.en.md b/docs/manual/guides/local-installation/ddev.en.md index 3aa0cf9fc..b47e4cd26 100644 --- a/docs/manual/guides/local-installation/ddev.en.md +++ b/docs/manual/guides/local-installation/ddev.en.md @@ -54,7 +54,7 @@ Install Contao 5.3: ddev composer create contao/managed-edition:5.3 ``` -After installation, the database access data must be entered in the .env.local. At the same time, we also set up +After installation, the database credentials must be entered in the .env.local. At the same time, we also set up [Mailpit](https://ddev.readthedocs.io/en/stable/users/usage/developer-tools/#email-capture-and-review-mailpit) directly. ```shell @@ -70,7 +70,7 @@ ddev exec contao-console contao:migrate --no-interaction Create backend user (Administrator): ```shell -ddev exec contao-console contao:user:create --username=admin --name=Administrator --email=admin@example.com --language=en --password=Password123 --admin +ddev exec contao-console contao:user:create --username=admin --name=Administrator --email=admin@example.com --language=en --admin ``` Call up the Administration in the browser: From a4f25baf767ad8432255869f38e9f5793d5895c3 Mon Sep 17 00:00:00 2001 From: fkaminski Date: Thu, 7 Nov 2024 15:08:21 +0100 Subject: [PATCH 09/11] formatting --- docs/manual/guides/local-installation/ddev.en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manual/guides/local-installation/ddev.en.md b/docs/manual/guides/local-installation/ddev.en.md index b47e4cd26..b3c340bfd 100644 --- a/docs/manual/guides/local-installation/ddev.en.md +++ b/docs/manual/guides/local-installation/ddev.en.md @@ -54,7 +54,7 @@ Install Contao 5.3: ddev composer create contao/managed-edition:5.3 ``` -After installation, the database credentials must be entered in the .env.local. At the same time, we also set up +After installation, the database credentials must be entered in the `.env.local`. At the same time, we also set up [Mailpit](https://ddev.readthedocs.io/en/stable/users/usage/developer-tools/#email-capture-and-review-mailpit) directly. ```shell From 02df3fe3edcfa0b4a99c465f8857deeafd23b0b6 Mon Sep 17 00:00:00 2001 From: Franko Date: Sun, 10 Nov 2024 07:56:27 +0100 Subject: [PATCH 10/11] Update docs/manual/guides/local-installation/ddev.de.md Co-authored-by: Fritz Michael Gschwantner --- docs/manual/guides/local-installation/ddev.de.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manual/guides/local-installation/ddev.de.md b/docs/manual/guides/local-installation/ddev.de.md index 3d5181c0d..eee07dc2e 100644 --- a/docs/manual/guides/local-installation/ddev.de.md +++ b/docs/manual/guides/local-installation/ddev.de.md @@ -35,7 +35,7 @@ installiert](https://github.com/contao/contao-demo) werden. Über den Contao Man Option auswählen. {{% /notice %}} -{{< tabs groupId="Example">}} +{{< tabs groupId="ddev-contao-install">}} {{% tab name="Composer" %}} Öffne die Konsole deiner Wahl, erstelle das gewünschte Verzeichnis und wechsle danach in ebendieses. Der Verzeichnisname spiegelt den späteren Projekt Hostnamen. Du kannst dies jedoch zusätzlich [konfigurieren](https://ddev.readthedocs.io/en/latest/users/extend/additional-hostnames/). From 997bb433427ae7e60662cacd105cb100123b7eee Mon Sep 17 00:00:00 2001 From: Franko Date: Sun, 10 Nov 2024 07:56:36 +0100 Subject: [PATCH 11/11] Update docs/manual/guides/local-installation/ddev.en.md Co-authored-by: Fritz Michael Gschwantner --- docs/manual/guides/local-installation/ddev.en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manual/guides/local-installation/ddev.en.md b/docs/manual/guides/local-installation/ddev.en.md index b3c340bfd..640a0f053 100644 --- a/docs/manual/guides/local-installation/ddev.en.md +++ b/docs/manual/guides/local-installation/ddev.en.md @@ -33,7 +33,7 @@ The [Contao demo website](https://demo.contao.org/) is maintained for the curren installed](https://github.com/contao/contao-demo). Via the Contao Manager you can simply select this option during the first installation. {{% /notice %}} -{{< tabs groupId="Example">}} +{{< tabs groupId="ddev-contao-install">}} {{% tab name="Composer" %}} Open the console of your choice, create the desired directory and then change to it. The directory name reflects the subsequent project hostname. However, you can [configure this](https://ddev.readthedocs.io/en/latest/users/extend/additional-hostnames/) additionally.