diff --git a/docs/manual/guides/local-installation/ddev.de.md b/docs/manual/guides/local-installation/ddev.de.md index 8f1b6928d..eee07dc2e 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="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/). ```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,49 +56,83 @@ Contao 5.3 installieren: ddev composer create contao/managed-edition:5.3 ``` -Nach der Installation müssen die Datenbankzugangsdaten in die `.env.local` eingetragen werden. In diesem Zug richten wir auch direkt Mailpit ein. +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. -```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" %}} + +Ö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 >}} -{{% /notice %}} ## 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 756ce865e..640a0f053 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="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. ```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,51 +54,83 @@ 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 Mailpit directly. +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. -```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 --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 %}} + +{{< /tabs >}} -The `ddev` binary is not available in the container, so first switch to the host console with `exit`. ## 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`).