├── .gitignore ├── tests ├── testdata │ └── .gitmanaged ├── package.json ├── run-ddev-browsersync └── test.bats ├── web-build └── Dockerfile.ddev-browsersync ├── config.browsersync.yaml ├── commands └── web │ └── browsersync ├── scripts ├── wp-config-ddev-browsersync.php ├── remove-wordpress-settings.sh └── setup-wordpress-settings.sh ├── browser-sync.cjs ├── .github ├── PULL_REQUEST_TEMPLATE.md ├── workflows │ └── tests.yml └── ISSUE_TEMPLATE │ ├── feature_request.yml │ └── bug_report.yml ├── install.yaml ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /.idea 2 | -------------------------------------------------------------------------------- /tests/testdata/.gitmanaged: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "test-browsersync", 3 | "type": "module" 4 | } 5 | -------------------------------------------------------------------------------- /web-build/Dockerfile.ddev-browsersync: -------------------------------------------------------------------------------- 1 | #ddev-generated 2 | RUN npm install -g browser-sync 3 | -------------------------------------------------------------------------------- /config.browsersync.yaml: -------------------------------------------------------------------------------- 1 | #ddev-generated 2 | web_extra_exposed_ports: 3 | - name: browsersync 4 | container_port: 3000 5 | http_port: 3001 6 | https_port: 3000 7 | -------------------------------------------------------------------------------- /tests/run-ddev-browsersync: -------------------------------------------------------------------------------- 1 | #!/usr/bin/expect -f 2 | 3 | set PROJNAME $::env(PROJNAME) 4 | set timeout 10 5 | 6 | spawn ddev browsersync 7 | expect "https?://${PROJNAME}.ddev.site:3000" 8 | -------------------------------------------------------------------------------- /commands/web/browsersync: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #ddev-generated 4 | ## Description: Run browser-sync in the web container 5 | ## Usage: browsersync 6 | ## Example: "ddev browsersync" 7 | ## ExecRaw: true 8 | 9 | echo "Proxying Browsersync on $(echo ${DDEV_PRIMARY_URL} | sed -E 's/:[0-9]+//'):3000" 10 | browser-sync start -c /var/www/html/.ddev/browser-sync.cjs | grep -v "Access URLs\|--------------------\|Local: http\|External: http" 11 | -------------------------------------------------------------------------------- /scripts/wp-config-ddev-browsersync.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | 6 | 7 | ## How This PR Solves The Issue 8 | 9 | ## Manual Testing Instructions 10 | 11 | ```bash 12 | ddev add-on get https://github.com///tarball/ 13 | ddev restart 14 | ``` 15 | 16 | ## Automated Testing Overview 17 | 18 | 19 | 20 | ## Release/Deployment Notes 21 | 22 | 23 | -------------------------------------------------------------------------------- /scripts/remove-wordpress-settings.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | #ddev-generated 3 | set -e 4 | 5 | if [[ "$DDEV_PROJECT_TYPE" != "wordpress" ]] ; 6 | then 7 | exit 0 8 | fi 9 | 10 | # if ( ddev debug configyaml 2>/dev/null | grep 'disable_settings_management:\s*true' >/dev/null 2>&1 ) ; then 11 | # exit 0 12 | # fi 13 | 14 | if [ "$DDEV_DOCROOT" != "" ]; then 15 | DDEV_SITE_PATH="${DDEV_APPROOT}/${DDEV_DOCROOT}" ; 16 | else 17 | DDEV_SITE_PATH=$DDEV_APPROOT 18 | fi 19 | 20 | SETTINGS_FILE_NAME="${DDEV_SITE_PATH}/wp-config.php" 21 | 22 | echo "Removing wp-config-ddev-browsersync.php from: ${SETTINGS_FILE_NAME}" 23 | 24 | # Remove the ddev-browsersync config that we added. 25 | awk ' 26 | /\/\*\* Include for ddev-browsersync to modify WP_HOME and WP_SITEURL\./ { skip=1 } 27 | skip && /\}.*$/ { skip=0; getline; next } 28 | !skip 29 | ' "${DDEV_SITE_PATH}/wp-config.php" > "${DDEV_SITE_PATH}/wp-config-temp.php" 30 | mv "${DDEV_SITE_PATH}/wp-config-temp.php" "${DDEV_SITE_PATH}/wp-config.php" 31 | -------------------------------------------------------------------------------- /.github/workflows/tests.yml: -------------------------------------------------------------------------------- 1 | name: tests 2 | on: 3 | pull_request: 4 | push: 5 | branches: [ main ] 6 | 7 | schedule: 8 | - cron: '25 08 * * *' 9 | 10 | workflow_dispatch: 11 | inputs: 12 | debug_enabled: 13 | type: boolean 14 | description: Debug with tmate 15 | required: false 16 | default: false 17 | 18 | concurrency: 19 | group: ${{ github.workflow }}-${{ github.ref }} 20 | cancel-in-progress: true 21 | 22 | # This is required for "gautamkrishnar/keepalive-workflow", see "ddev/github-action-add-on-test" 23 | permissions: 24 | actions: write 25 | 26 | jobs: 27 | tests: 28 | strategy: 29 | matrix: 30 | ddev_version: [stable, HEAD] 31 | fail-fast: false 32 | 33 | runs-on: ubuntu-latest 34 | 35 | steps: 36 | - name: Environment setup 37 | run: | 38 | (sudo apt-get update >/dev/null || true) && sudo apt-get install -y expect >/dev/null 39 | 40 | - uses: ddev/github-action-add-on-test@v2 41 | with: 42 | ddev_version: ${{ matrix.ddev_version }} 43 | token: ${{ secrets.GITHUB_TOKEN }} 44 | debug_enabled: ${{ github.event.inputs.debug_enabled }} 45 | addon_repository: ${{ env.GITHUB_REPOSITORY }} 46 | addon_ref: ${{ env.GITHUB_REF }} 47 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.yml: -------------------------------------------------------------------------------- 1 | name: 🚀 Feature request 2 | description: Suggest an idea for this project. 3 | labels: [enhancement] 4 | body: 5 | - type: checkboxes 6 | attributes: 7 | label: Is there an existing issue for this? 8 | description: Please search existing issues to see if one already exists for your request. 9 | options: 10 | - label: I have searched the existing issues 11 | required: true 12 | - type: textarea 13 | attributes: 14 | label: Is your feature request related to a problem? 15 | description: Clearly and concisely describe the problem. (Ex. I'm always frustrated when...) 16 | validations: 17 | required: true 18 | - type: textarea 19 | attributes: 20 | label: Describe your solution 21 | description: Clearly and concisely describe what you want to happen. 22 | validations: 23 | required: true 24 | - type: textarea 25 | attributes: 26 | label: Describe alternatives 27 | description: Clearly and concisely describe any alternative solutions or features you've considered. 28 | validations: 29 | required: false 30 | - type: textarea 31 | attributes: 32 | label: Additional context 33 | description: Add any other context or screenshots about the feature request. 34 | validations: 35 | required: false 36 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.yml: -------------------------------------------------------------------------------- 1 | name: 🐞 Bug report or Support Request 2 | description: Create a report to help us improve. 3 | labels: [bug] 4 | body: 5 | - type: checkboxes 6 | attributes: 7 | label: Preliminary checklist 8 | description: Please complete the following checks before submitting an issue. 9 | options: 10 | - label: I am using the latest stable version of DDEV 11 | required: true 12 | - label: I am using the latest stable version of this add-on 13 | required: true 14 | - type: textarea 15 | attributes: 16 | label: Expected Behavior 17 | description: What did you expect to happen? 18 | validations: 19 | required: true 20 | - type: textarea 21 | attributes: 22 | label: Actual Behavior 23 | description: What actually happened instead? 24 | validations: 25 | required: true 26 | - type: textarea 27 | attributes: 28 | label: Steps To Reproduce 29 | description: Specific steps to reproduce the behavior. 30 | placeholder: | 31 | 1. In this environment... 32 | 2. With this config... 33 | 3. Run `...` 34 | 4. See error... 35 | validations: 36 | required: false 37 | - type: textarea 38 | attributes: 39 | label: Anything else? 40 | description: | 41 | Links? References? Screenshots? Anything that will give us more context about your issue! 42 | 43 | 💡 Attach images or log files by clicking this area to highlight it and dragging files in. 44 | validations: 45 | required: false 46 | -------------------------------------------------------------------------------- /scripts/setup-wordpress-settings.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | #ddev-generated 3 | set -e 4 | 5 | if [[ "$DDEV_PROJECT_TYPE" != "wordpress" ]] ; 6 | then 7 | exit 0 8 | fi 9 | 10 | # if ( ddev debug configyaml 2>/dev/null | grep 'disable_settings_management:\s*true' >/dev/null 2>&1 ) ; then 11 | # exit 0 12 | # fi 13 | 14 | if [ "$DDEV_DOCROOT" != "" ]; then 15 | DDEV_SITE_PATH="${DDEV_APPROOT}/${DDEV_DOCROOT}" ; 16 | else 17 | DDEV_SITE_PATH=$DDEV_APPROOT 18 | fi 19 | 20 | cp scripts/wp-config-ddev-browsersync.php "$DDEV_SITE_PATH/" 21 | 22 | SETTINGS_FILE_NAME="${DDEV_SITE_PATH}/wp-config.php" 23 | 24 | echo "Settings file name: ${SETTINGS_FILE_NAME}" 25 | 26 | # If wp-config.php already contains the require_once() then exit early. 27 | if grep -q "/\*\* Include for ddev-browsersync to modify WP_HOME and WP_SITEURL. \*/" "${DDEV_SITE_PATH}/wp-config.php"; then 28 | exit 0 29 | fi 30 | 31 | echo "Adding wp-config-ddev-browsersync.php to: ${SETTINGS_FILE_NAME}" 32 | 33 | # Append our code before the ddev config comment. 34 | awk ' 35 | /\/\/ Include for settings managed by ddev./ { 36 | print "/** Include for ddev-browsersync to modify WP_HOME and WP_SITEURL. */" 37 | print "$ddev_browsersync_settings = __DIR__ . '\''/wp-config-ddev-browsersync.php'\'';" 38 | print "if ( getenv( '\''IS_DDEV_PROJECT'\'' ) == '\''true'\'' && is_readable( $ddev_browsersync_settings ) ) {" 39 | print " require_once( $ddev_browsersync_settings );" 40 | print "}" 41 | print "" 42 | print "// Include for settings managed by ddev." 43 | next 44 | } 45 | {print} 46 | ' "${DDEV_SITE_PATH}/wp-config.php" > "${DDEV_SITE_PATH}/wp-config-temp.php" 47 | 48 | # Replace the real config file with the modified version in temporary file. 49 | mv "${DDEV_SITE_PATH}/wp-config-temp.php" "${DDEV_SITE_PATH}/wp-config.php" 50 | -------------------------------------------------------------------------------- /install.yaml: -------------------------------------------------------------------------------- 1 | name: ddev-browsersync 2 | 3 | project_files: 4 | - config.browsersync.yaml 5 | - web-build/Dockerfile.ddev-browsersync 6 | - browser-sync.cjs 7 | - commands/web/browsersync 8 | - scripts/wp-config-ddev-browsersync.php 9 | - scripts/remove-wordpress-settings.sh 10 | - scripts/setup-wordpress-settings.sh 11 | 12 | ddev_version_constraint: '>= v1.24.3' 13 | 14 | post_install_actions: 15 | - | 16 | #ddev-nodisplay 17 | #ddev-description:Check for global browsersync 18 | if test -f "$HOME/.ddev/commands/web/browsersync"; then 19 | echo "Note: '~/.ddev/commands/web/browsersync' is no longer required and can be safely removed." && exit 0 20 | fi 21 | - | 22 | #ddev-nodisplay 23 | #ddev-description:Check for 'browser-sync.js' 24 | if test -f "$DDEV_APPROOT/commands/web/browsersync.js"; then 25 | echo "Note: '$DDEV_APPROOT/commands/web/browsersync.js' is no longer required and can be safely removed." && exit 0 26 | fi 27 | - | 28 | #ddev-nodisplay 29 | #ddev-description:Remove old 'docker-compose.browsersync.yaml' 30 | if grep "#ddev-generated" $DDEV_APPROOT/.ddev/docker-compose.browsersync.yaml 2>/dev/null; then 31 | rm -f "$DDEV_APPROOT/.ddev/docker-compose.browsersync.yaml" 32 | fi 33 | - | 34 | #ddev-nodisplay 35 | #ddev-description:Install browsersync settings for WordPress if applicable 36 | scripts/setup-wordpress-settings.sh 37 | - | 38 | #ddev-nodisplay 39 | #ddev-description:Check for WordPress and disable ddev management of wp-config file 40 | if [[ $DDEV_PROJECT_TYPE = 'wordpress' ]]; then 41 | ddev config --disable-settings-management=true; 42 | fi 43 | 44 | 45 | removal_actions: 46 | - | 47 | #ddev-nodisplay 48 | #ddev-description:Remove browsersync settings for WordPress if applicable 49 | if [ "$DDEV_DOCROOT" != "" ]; then 50 | DDEV_SITE_PATH="${DDEV_APPROOT}/${DDEV_DOCROOT}" ; 51 | else 52 | DDEV_SITE_PATH=$DDEV_APPROOT 53 | fi 54 | rm -f "${DDEV_SITE_PATH}/wp-config-ddev-browsersync.php" 55 | scripts/remove-wordpress-settings.sh 56 | # Don't automatically renable settings management in case user didn't have it enabled in the first place 57 | - | 58 | if [ "$DDEV_PROJECT_TYPE" = "wordpress" ]; then 59 | echo "Note: You may wish to renable ddev's management of the wp-config file:" 60 | echo " Run 'ddev config --disable-settings-management=false && ddev restart'" 61 | fi 62 | -------------------------------------------------------------------------------- /tests/test.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | # Bats is a testing framework for Bash 4 | # Documentation https://bats-core.readthedocs.io/en/stable/ 5 | # Bats libraries documentation https://github.com/ztombol/bats-docs 6 | 7 | # For local tests, install bats-core, bats-assert, bats-file, bats-support 8 | # And run this in the add-on root directory: 9 | # bats ./tests/test.bats 10 | # To exclude release tests: 11 | # bats ./tests/test.bats --filter-tags '!release' 12 | # For debugging: 13 | # bats ./tests/test.bats --show-output-of-passing-tests --verbose-run --print-output-on-failure 14 | 15 | setup() { 16 | set -eu -o pipefail 17 | 18 | # Override this variable for your add-on: 19 | export GITHUB_REPO=ddev/ddev-browsersync 20 | 21 | TEST_BREW_PREFIX="$(brew --prefix 2>/dev/null || true)" 22 | export BATS_LIB_PATH="${BATS_LIB_PATH}:${TEST_BREW_PREFIX}/lib:/usr/lib/bats" 23 | bats_load_library bats-assert 24 | bats_load_library bats-file 25 | bats_load_library bats-support 26 | 27 | export DIR="$(cd "$(dirname "${BATS_TEST_FILENAME}")/.." >/dev/null 2>&1 && pwd)" 28 | export PROJNAME="test-$(basename "${GITHUB_REPO}")" 29 | mkdir -p ~/tmp 30 | export TESTDIR=$(mktemp -d ~/tmp/${PROJNAME}.XXXXXX) 31 | export DDEV_NONINTERACTIVE=true 32 | export DDEV_NO_INSTRUMENTATION=true 33 | ddev delete -Oy "${PROJNAME}" >/dev/null 2>&1 || true 34 | 35 | # Copy script 36 | cp tests/run-ddev-browsersync "${TESTDIR}" 37 | 38 | cd "${TESTDIR}" 39 | run ddev config --project-name="${PROJNAME}" --project-tld=ddev.site 40 | assert_success 41 | 42 | # Add simple page to test against. 43 | echo "this is a test" >index.html 44 | 45 | run ddev start -y 46 | assert_success 47 | } 48 | 49 | health_checks() { 50 | run curl -sfI https://${PROJNAME}.ddev.site:3000 51 | assert_success 52 | assert_output --partial "HTTP/2 200" 53 | 54 | run curl -sf https://${PROJNAME}.ddev.site:3000 55 | assert_success 56 | assert_output --partial "this is a test" 57 | } 58 | 59 | teardown() { 60 | set -eu -o pipefail 61 | ddev delete -Oy ${PROJNAME} >/dev/null 2>&1 62 | [ "${TESTDIR}" != "" ] && rm -rf ${TESTDIR} 63 | } 64 | 65 | @test "install from directory" { 66 | set -eu -o pipefail 67 | 68 | echo "# ddev add-on get ${DIR} with project ${PROJNAME} in $(pwd)" >&3 69 | run ddev add-on get "${DIR}" 70 | assert_success 71 | 72 | run ddev restart -y 73 | assert_success 74 | 75 | ./run-ddev-browsersync & 76 | sleep 5 77 | 78 | health_checks 79 | } 80 | 81 | # bats test_tags=release 82 | @test "install from release" { 83 | set -eu -o pipefail 84 | 85 | echo "# ddev add-on get ${GITHUB_REPO} with project ${PROJNAME} in $(pwd)" >&3 86 | run ddev add-on get "${GITHUB_REPO}" 87 | assert_success 88 | 89 | run ddev restart -y 90 | assert_success 91 | 92 | ./run-ddev-browsersync & 93 | sleep 5 94 | 95 | health_checks 96 | } 97 | 98 | @test "ES module environment" { 99 | set -eu -o pipefail 100 | 101 | # Setup NPM environment 102 | cp "${DIR}/tests/package.json" "${TESTDIR}" 103 | 104 | echo "# ddev add-on get ${DIR} with project ${PROJNAME} in $(pwd)" >&3 105 | run ddev add-on get "${DIR}" 106 | assert_success 107 | 108 | run ddev restart -y 109 | assert_success 110 | 111 | ./run-ddev-browsersync & 112 | sleep 5 113 | 114 | health_checks 115 | } 116 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![add-on registry](https://img.shields.io/badge/DDEV-Add--on_Registry-blue)](https://addons.ddev.com) 2 | [![tests](https://github.com/ddev/ddev-browsersync/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/ddev/ddev-browsersync/actions/workflows/tests.yml?query=branch%3Amain) 3 | [![last commit](https://img.shields.io/github/last-commit/ddev/ddev-browsersync)](https://github.com/ddev/ddev-browsersync/commits) 4 | [![release](https://img.shields.io/github/v/release/ddev/ddev-browsersync)](https://github.com/ddev/ddev-browsersync/releases/latest) 5 | 6 | # DDEV Browsersync 7 | 8 | - [Overview](#overview) 9 | - [Installation](#installation) 10 | - [Usage](#usage) 11 | - [Auto-start the watcher server](#auto-start-the-watcher-server) 12 | - [What does this add-on do?](#what-does-this-add-on-do) 13 | - [Integrations](#integrations) 14 | - [Laravel Mix Configuration](#laravel-mix-configuration) 15 | - [WordPress Configuration Changes](#wordpress-configuration-changes) 16 | - [Others](#others) 17 | - [Troubleshooting](#troubleshooting) 18 | - [No Gateway / 502 error](#no-gateway--502-error) 19 | - [Unknown command "browsersync" for "ddev"](#unknown-command-browsersync-for-ddev) 20 | - [System limit for number of file watchers reached](#system-limit-for-number-of-file-watchers-reached) 21 | - [Credits](#credits) 22 | 23 | ## Overview 24 | 25 | [Browsersync](https://browsersync.io/) is free software that features: 26 | 27 | - live reloads 28 | - click mirroring 29 | - network throttling 30 | 31 | This add-on allows you to run [Browsersync](https://browsersync.io/) through the DDEV web service. 32 | 33 | ## Installation 34 | 35 | To install this add-on, run: 36 | 37 | ```bash 38 | ddev add-on get ddev/ddev-browsersync 39 | ddev restart 40 | ``` 41 | 42 | After installation, make sure to commit the `.ddev` directory to version control. 43 | 44 | ## Usage 45 | 46 | | Command | Description | 47 | | ------- | ----------- | 48 | | `ddev browsersync` | Start the watcher | 49 | | `ddev launch :3000` | Launch the Browsersync page | 50 | 51 | Examples: 52 | 53 | ```bash 54 | $ ddev browsersync 55 | Proxying Browsersync on https://mysite.ddev.site:3000 56 | [Browsersync] Proxying: http://localhost 57 | [Browsersync] Watching files... 58 | 59 | $ ddev launch :3000 60 | # The site should briefly display "Browsersync: connect" 61 | # in the top right corner, confirming it is connect to the server. 62 | ``` 63 | 64 | ### Auto-start the watcher server 65 | 66 | You can use DDEV's `post-start` hook to start the watcher server and launch the page when DDEV starts. 67 | 68 | ```bash 69 | cat <<'EOF' > .ddev/config.browsersync-extras.yaml 70 | hooks: 71 | post-start: 72 | - exec-host: bash -c "ddev browsersync &" 73 | - exec-host: ddev launch :3000 74 | EOF 75 | 76 | ddev restart 77 | ``` 78 | 79 | ## What does this add-on do? 80 | 81 | 1. Checks to make sure the DDEV version is adequate. 82 | 2. Adds `.ddev/web-build/Dockerfile.ddev-browsersync`, which installs Browsersync using npm. 83 | 3. Adds a `browser-sync.js` to define the operation of the base setup. 84 | 4. Adds a `.ddev/docker-compose.browsersync.yaml`, which exposes and routes the ports necessary. 85 | 5. Adds a `ddev browsersync` shell command, which lets you easily start Browsersync when you want it. 86 | 87 | For WordPress projects, this add-on also: 88 | 89 | - Adds a `wp-config-ddev-browser.php` file which modifies the WP_HOME and WP_SITEURL values to work with Browsersync. 90 | - On install, modifies the `wp-config-ddev.php` file to include the `wp-config-ddev-browser.php` file. 91 | 92 | ## Integrations 93 | 94 | `ddev-browsersync` works out of the box for many project types. 95 | However, you may want to edit the `.ddev/browser-sync.js` file to specify exactly what files and directories 96 | should be watched. Limiting watched files may reduce hard disk and CPU loads. 97 | 98 | ### Laravel Mix Configuration 99 | 100 | Demo: 101 | 102 | - Update `webpack.mix.js` 103 | 104 | ```js 105 | // Use the HOSTNAME provided by DDEV 106 | let url = process.env.DDEV_HOSTNAME; 107 | 108 | mix.js('resources/js/app.js', 'public/js') 109 | .postCss('resources/css/app.css', 'public/css', [ 110 | // 111 | ]) 112 | .browserSync({ 113 | proxy: "localhost", 114 | host: url, 115 | open: false, 116 | ui: false 117 | }); 118 | ``` 119 | 120 | - Start Browsersync service 121 | 122 | ```shell 123 | ddev exec npm run watch 124 | ... 125 | [Browsersync] Proxying: http://localhost:3000 126 | [Browsersync] Access URLs: 127 | --------------------------------------------------- 128 | Local: http://localhost:3000 129 | External: http://browsersync-demo.ddev.site:3000 130 | --------------------------------------------------- 131 | ``` 132 | 133 | - Browsersync will be running on **HTTPS** at `https://browsersync-demo.ddev.site:3000` 134 | 135 | ### WordPress Configuration Changes 136 | 137 | When this add-on is added to a WordPress project, DDEV's management of the installation files is turned 138 | off. 139 | 140 | The changes this add-on makes to the `wp-config-ddev.php` file during installation can be seen below. 141 | 142 | The `wp-config-ddev-browserync.php` file is included before the `/** WP_HOME URL */` comment. 143 | 144 | Before: 145 | 146 | ```php 147 | /** WP_HOME URL */ 148 | defined( 'WP_HOME' ) || define( 'WP_HOME', 'https://projectname.ddev.site' ); 149 | 150 | /** WP_SITEURL location */ 151 | defined( 'WP_SITEURL' ) || define( 'WP_SITEURL', WP_HOME . '/' ); 152 | ``` 153 | 154 | After: 155 | 156 | ```php 157 | /** Include WP_HOME and WP_SITEURL settings required for Browsersync. */ 158 | if ( ( file_exists( __DIR__ . '/wp-config-ddev-browsersync.php' ) ) ) { 159 | include __DIR__ . '/wp-config-ddev-browsersync.php'; 160 | } 161 | 162 | /** WP_HOME URL */ 163 | defined( 'WP_HOME' ) || define( 'WP_HOME', 'https://projectname.ddev.site' ); 164 | 165 | /** WP_SITEURL location */ 166 | defined( 'WP_SITEURL' ) || define( 'WP_SITEURL', WP_HOME . '/' ); 167 | ``` 168 | 169 | ### Others 170 | 171 | There are many other options to integrate Browsersync into your project, including: 172 | 173 | - [Grunt](https://browsersync.io/docs/grunt) 174 | - [Laravel Mix](https://laravel-mix.com/docs/4.0/browsersync) 175 | 176 | Please see [Browsersync documentation](https://browsersync.io/docs) for more details. 177 | 178 | ## Troubleshooting 179 | 180 | ### No Gateway / 502 error 181 | 182 | This error usually occurs when the watcher server is not running. 183 | Run `ddev browsersync` to start the server. 184 | 185 | ### Typo3 No site configuration found / 404 Error 186 | 187 | Solution: The base URL (`base` in the TYPO3 site's `config.yaml` (like `config/sites/main/config.yaml` should specify `http` even though the frontend is configured for `https`. This can also be solved by commenting out the default `base` line. 188 | ```yaml 189 | base: http://examplehost.ddev.site/ 190 | ``` 191 | 192 | ### Unknown command "browsersync" for "ddev" 193 | 194 | > :bulb: This add-on moves to a per-project command approach in v2.5.0+. You can safely delete the global `~/.ddev/commands/web/browsersync` once you’re on v2.5.0 or higher. 195 | 196 | If you run `ddev browsersync` from a local project and get `Error: unknown command "browsersync" for "ddev"`, please reinstall the add-on. 197 | 198 | ### System limit for number of file watchers reached 199 | 200 | This error means the watcher is unable to track all the files it is tasked with watching. 201 | You either have to decrease the number of files you’re watching or increase the file watcher limit. 202 | 203 | - Decrease the number of files you're watching by updating `browser-sync.js`: 204 | - Limit the number of files being watch by updating `files: [...]` section 205 | - Increase the number of ignored files by updating the `ignore: []` section 206 | - If you use Colima, run `colima ssh` and `sudo sysctl fs.inotify.max_user_watches` to see how many watches you have. To increase it, use something like `sudo sysctl -w fs.inotify.max_user_watches=2048576`. Unfortunately, this has to be done on every Colima restart. 207 | - If you use Docker Desktop for Mac, `docker run -it --privileged --pid=host justincormack/nsenter1` and `sysctl -w fs.inotify.max_user_watches=1048576`. Unfortunately, this has to be done again on every Docker restart. 208 | - On Docker Desktop for Windows, add or edit `~/.wslconfig` with these contents: 209 | 210 | ```conf 211 | [wsl2] 212 | kernelCommandLine = "fs.inotify.max_user_watches=1048576" 213 | ``` 214 | 215 | - On Linux, you can change `fs.inotify.max_user_watches` on the host in `/etc/sysctl.d/local.conf` or elsewhere. 216 | 217 | ## Credits 218 | 219 | PRs for install steps for specific frameworks are welcome. 220 | 221 | **Contributed and maintained by [@tyler36](https://github.com/tyler36)** 222 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------