diff --git a/src/.gitignore b/src/.gitignore index 1e748f4..fb315d1 100644 --- a/src/.gitignore +++ b/src/.gitignore @@ -1 +1,3 @@ -TYPO3.env \ No newline at end of file +TYPO3.env +.build +var \ No newline at end of file diff --git a/src/typo3/.devcontainer/README.md b/src/typo3/.devcontainer/README.md new file mode 100644 index 0000000..8ed347e --- /dev/null +++ b/src/typo3/.devcontainer/README.md @@ -0,0 +1,30 @@ +# Devcontainer template `typo3` + +Homepage: [Github](https://github.com/thucke/devcontainer-templates/tree/main/src/typo3) + +## Working in the TYPO3 Devcontainer + + After the TYPO3 devcontainer environment came up you will find in a container running Debian Trixie: + + * User: `typo3dev` + * Homedirectory: `/home/typo3dev` + * SUDO-command: *passwordless for any command* + * Git-Repository: checked out to `${WORKSPACE_ROOT}` + +## Re-Initialize TYPO3 environment + + If you need to get a clean TYPO3 environment based upon your configuration you may spawn a terminal window and execute + + `${WORKSPACE_ROOT}/.devcontainer/docker/igniteEnvironment.sh` + +## Update devcontainer template + +If you want to update the devcontainer configuration e.g. after a new template version has been published you can make use of the [Dev Container CLI](https://github.com/devcontainers/cli) with the following command: + + devcontainer templates apply --template-id ghcr.io/thucke/devcontainer-templates/typo3 --template-args "{\"database\": \"mysql\"}" -w ${WORKSPACE_ROOT}. + +## TYPO3 environment configuration + + You may modify the file `${WORKSPACE_ROOT}/.devcontainer/.env` with caution if you want to adjust some core TYPO3 settings. After this file has been modified it is recommended to rebuild the whole devcontainer. + + **In this file you can find the password of the database root as well as the TYPO3 backend user credentials.** \ No newline at end of file diff --git a/src/typo3/.gitignore b/src/typo3/.gitignore deleted file mode 100644 index 9e27bb2..0000000 --- a/src/typo3/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -.build -var \ No newline at end of file diff --git a/src/typo3/NOTES.md b/src/typo3/NOTES.md index fbf6185..3cb47d8 100644 --- a/src/typo3/NOTES.md +++ b/src/typo3/NOTES.md @@ -70,6 +70,12 @@ Some requirements regarding the composer configuration are automatically set dur `${WORKSPACE_ROOT}/.devcontainer/docker/igniteEnvironment.sh` +* Update devcontainer template + +If you want to update the devcontainer configuration e.g. after a new template version has been published you can make use of the [Dev Container CLI](https://github.com/devcontainers/cli) with the following command: + + devcontainer templates apply --template-id ghcr.io/thucke/devcontainer-templates/typo3 --template-args "{\"database\": \"mysql\"}" -w ${WORKSPACE_ROOT}. + * TYPO3 environment configuration You may modify the file `${WORKSPACE_ROOT}/.devcontainer/.env` with caution if you want to adjust some core TYPO3 settings. After this file has been modified it is recommended to rebuild the whole devcontainer. diff --git a/src/typo3/devcontainer-template.json b/src/typo3/devcontainer-template.json index 35128ca..29cd073 100644 --- a/src/typo3/devcontainer-template.json +++ b/src/typo3/devcontainer-template.json @@ -1,6 +1,6 @@ { "id": "typo3", - "version": "0.3.0", + "version": "0.3.1", "name": "Typo3", "description": "A template to support remote development with TYPO3.", "documentationURL": "https://github.com/thucke/devcontainer-templates/tree/main/src/typo3",