https://github.com/flownative/docker-localbeach-devkit
The Local Beach Dev Kit
https://github.com/flownative/docker-localbeach-devkit
docker-image flownative-beach localbeach
Last synced: about 1 year ago
JSON representation
The Local Beach Dev Kit
- Host: GitHub
- URL: https://github.com/flownative/docker-localbeach-devkit
- Owner: flownative
- Created: 2020-02-28T11:09:08.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-06-29T09:09:47.000Z (almost 4 years ago)
- Last Synced: 2024-04-13T19:32:27.635Z (about 2 years ago)
- Topics: docker-image, flownative-beach, localbeach
- Language: Shell
- Size: 45.9 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Local Beach Dev Kit
This Docker image is used as a sidecar-container in Local Beach
development environments and takes care of synchronizing files from the
host (your machine) to a shared volume. This is usually only necessary
in MacOS environments, because file access is too slow when you are
mounting a host directory to the container directly.
## Background
A sync daemon, based on inotify, watches a source directory and
synchronizes all changes – that is, files or directories created,
modified or deleted – to a target directory.
In a Local Beach setup, the source directory is called
"application-on-host" and is a direct mount of the application directory
on the developer's computer. The target directory is called
"application" and is a Docker volume which is shared across the Nginx
and PHP-FPM container.
See Local Beach for further details about which directory mounts exist.
## Usage
Make sure that a shared volume – for example called "application" -
exists in your Docker Compose configuration:
````yaml
volumes:
application:
name: myproject-application
driver: local
````
Then include the Local Beach Dev Kit image as an additional container:
```yaml
devkit:
image: flownative/localbeach-devkit
volumes:
- application:/application
- .:/application-on-host:delegated
```
## Configuration
You can override source and target paths by setting the environment
variables `SYNC_APPLICATION_ON_HOST_PATH` and `SYNC_APPLICATION_PATH`
respectively.