Full example

This file contains the configuration for your workspace. For a more in detail description, check the menu on the left and select the section you want more informations about.
1
config:
2
  workspaceFolder: workspaces
3
  proxy:
4
    domain: dev.localhost
5
    subDomain: example
6
php:
7
  version: 8.1
8
  config:
9
    opcache.enable: off
10
    xdebug.mode: off
11
    xdebug.start_with_request: yes
12
  configWeb:
13
    memory_limit: 512M
14
  configCLI:
15
    max_execution_time: 0
16
    memory_limit: -1
17
  packages:
18
  - php-soap
19
nodejs:
20
  version: 20.0.0
21
services:
22
  traefik:
23
    name: Reverse Proxy for Web Development
24
    category: proxy
25
    active: true
26
    port: 8080
27
    subDomain: traefik
28
  mysql:
29
    name: MySQL Server - Relational Database
30
    category: database
31
    active: false
32
  mailpit:
33
    name: Mailpit - Email Testing Tool
34
    active: true
35
    category: mail
36
    port: 8025
37
    subDomain: mail
38
  redis:
39
    name: Redis - In-Memory Key-Value Store
40
    category: cache
41
  phpmyadmin:
42
    name: PhpMyAdmin - MySQL Admin Tool
43
    category: tools
44
    port: 80
45
    subDomain: pma
46
  phpcacheadmin:
47
    name: PhpCacheAdmin - UI for managing PHP cache systems
48
    category: tools
49
    port: 80
50
    subDomain: pca
51
shellScripts:
52
  additionalDirectories:
53
  - scripts
54
tasks:
55
  services:
56
    name: Start the active services
57
    init:
58
    - webdev services start -d
59
  settings:
60
    name: Restore all settings for nodejs, php etc.
61
    create:
62
    - webdev restore all
63
    start:
64
    - webdev restore all
65
  install:
66
    name: Run composer install and setup everything
67
    onlyMain: false
68
    create:
69
    - webdev shopware setup
70
  apache:
71
    name: Start apache
72
    start:
73
    - apachectl start
74
  info:
75
    name: Show information about the development environment
76
    start:
77
    - webdev info --no-header
78
secrets:
79
  ComposerSecret:
80
    missingMessage: Secrets.Missing.Composer
81
    source:
82
      key: auth
83
      group: composer
84
    target:
85
      file: auth.json
86
      expectedSecrets:
87
        - GitLab
88
        - Package Repository
89
  GitlabDockerLoginSecret:
90
    missingMessage: Secrets.Missing.DockerLogin.Gitlab
91
    source:
92
      key: gitlab_docker_login
93
      group: docker
94
    target:
95
      envVar: file
96
      expectedVars:
97
        - DOCKER_USERNAME
98
        - DOCKER_PASSWORD
99
tests:
100
  lint:
101
    name: Run php-cs-fixer and phpstan
102
    tests:
103
    - phpcsfixer
104
    - phpstan
105
  phpcsfixer:
106
    name: Run php-cs-fixer
107
    commands:
108
    - php vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php -vvv --dry-run --diff --using-cache=no
109
  phpcsfixer-fix:
110
    name: Run php-cs-fixer fix
111
    commands:
112
    - php vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php -vvv --diff --using-cache=no
113
  phpstan:
114
    name: Run phpstan
115
    commands:
116
    - php -d memory_limit=1G vendor/bin/phpstan analyze -c phpstan.dist.neon
117
  phpstan-baseline:
118
    name: Generate phpstan baseline
119
    commands:
120
    - php -d memory_limit=1G vendor/bin/phpstan analyze -c phpstan.dist.neon --generate-baseline
121
  phpunit:
122
    name: Run phpunit
123
    commands:
124
    - php vendor/bin/phpunit --testdox --colors
125
  coverage:
126
    name: Run phpunit with coverage
127
    commands:
128
    - XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-html coverage
129
workspaces:
130
  main:
131
    subDomains:
132
    - test1
133
    - test2
134
  cms:
135
    name: Test workspace
136
    description: This is a test workspace for webdev
137
    repository: https://github.com/Derroylo/webdev-tool.git
138
    branch: main
139
    folder: cms
140
    docRoot: public
141
    mode: vhost
142
    subDomains:
143
      - cms
144
      - sulu
145
    disableWeb: false