Docker Storage Sync for Faster Development on MacOS and Windows

!Still only works on MacOS, documentation is also incomplete. please wait till release 1.0 +

Pleast note that this is a pre-release, functionality is still partial!
Wait for a newer update!!

---

What it does

sync-stat is an NPX CLI toolkit that offers an alternative to Docker Bind Mounts that is on par with Bind mounts on Linux Based FSs in terms of performance for MacOS.(Windows NTFS support is comming soon)

Docker with bind mounts can really cause a major performance penalty in MacOS (APPFS) and windows (NTFS)

Windows has WSL so it's not really effected but it would be nice if it would work as fast as bind mounts in linux in NTFS

sync-stat also offers some other options that docker cp / bind mounts do not offer. such as the ability to set an explicit user group and mode to the directory

---

Installation

Install via NPM

1npm i sync-stat

Configure - create sync-compose.yaml

create a YAML file named sync-compose.yaml at the root directory of your project

1version: 1
2
3containers: #Array
4  - name-of-container: #Array - must be defined in docker-compose or name container on start
5      volumes: # Bind Mounts - Array
6        - volume: # Item - config for each bind
7            profile: local # profile names will group volumes, can use run <profilename> to activate only the volumes in the group. if empty it will be activated too.
8            from: app/ # From location relative to <ProjectRoot> => app/  || does not support ./app yet
9            to: /var/www/html/ # to location inside docker container
10            mode: 775 # Mode to write files
11            owner: www-data:www-data # owner to write files as
12            cmd: #Run the Following commands on start, this only runs 1 time
13              - npm install
14              - composer install
15            ignore: #ignore these directories when syncing
16              - node_modules/
17            replace: # replace these strings when copying
18              - 'localhost:mysql-db'
19
20database:
21  driver: mysql # Currently only mysql is supported
22  profile: staging # Profiles
23  method: export # [ export | dump ]
24  file: /path/to/dump.sql #[ ./relative | /absolute ]/path/to/dump.sql . will only be used when method is in export
25  server: # externel server config
26    database_user: user
27    database_name: dbname
28    database_pass: pass
29    host: server.name
30    port: 3306
31  local: # local server config. external servers can  be used too
32    provision: true # drop db if it exists, create if not exist. needs root password
33    database_user: user
34    database_name: dbname
35    database_pass: pass
36    root_password: root_password # only used for provision function
37    host: localhost
38    port: 3306

Example

docker-compose.yml

1version: '3.9'
2
3services:
4  wordpress:
5    container_name: mytest-container
6    image: some-image #REPLACE
7    volumes:
8      - ./app:/var/www/html # (IMPORTANT!) REMOVE THIS. sync-stat will Automaticall do this
9      # MOUNT CANNOT MATCH THE ONE IN SYNC-COMPOSE
10      # IF YOU DONT REMOVE THAT LINE, IT WILL CAUSE AN ERROR.
11    ports:
12      - '8000:80'
13    ## application is placed at /var/www/html

sync-compose.yaml

1version: 1
2
3containers:
4  - mytest-container:
5      volumes:
6        - volume:
7            profile: local
8            from: app/
9            to: /var/www/html/
10            mode: 775
11            owner: www-data:www-data
12            cmd:
13              - echo hi
14            ignore:
15              - node_modules/
16            replace:
17              - 'string:string'

RUN

Start your docker container or compose setup

make sure to name the container with matching names defined in the sync-compose.json

Start Sync

Once Containers are online run the following in the root directory

1npx syncstat run

running profiles

1npx syncstat run <profilename>

when using run <profilename>, only volumes that match the profile name will be added. volumes without profile names will be added as well.

Running DB

1npx syncstat db

or with profiles

1npx syncstat db <profile>