You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/pages/configuration/dev/files/sync.mdx
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -212,12 +212,12 @@ uploadExcludeFile: "" # Do not load exclude paths from a file
212
212
Sometimes it is useful to execute commands after the sync uploads files/directories between the local filesystem and the container.
213
213
214
214
:::warning
215
-
Make sure that post-sync commands will **<u>not</u>** trigger a new sync process which could lead to an **endless loop**.
215
+
Make sure that post-sync commands will **<u>not</u>** trigger a new sync process. This could lead to an **endless loop**.
216
216
:::
217
217
218
218
### `startContainer`
219
219
220
-
The `startContainer` option can be used to delay starting a container until sync has finished uploading all files initially. This is very useful if your container entrypoint requires certain files. Needs `command` to be set as otherwise DevSpace doesn't know which command to start.
220
+
The `startContainer` option can be used to delay starting a container until sync has finished uploading all files initially. This is very useful if your container entrypoint requires certain files. This option requires `command` to be set; otherwise, DevSpace will not know which command to start.
221
221
222
222
#### Example: Enable Container start
223
223
```yaml
@@ -247,7 +247,7 @@ If multiple sync paths with `startContainer` exist, DevSpace will wait for all t
247
247
The `restartContainer` option expects a boolean which defines if DevSpace should restart the container every time either a single file or even a batch of files have been uploaded to the container using file sync.
248
248
249
249
:::caution Restart Helper Required
250
-
Setting `restartContainer: true` requires to set `command: ["my", "container", "entrypoint"]`. Otherwise, DevSpace doesn't know which command to restart.
250
+
Setting `restartContainer: true` requires you to also set `command: ["my", "container", "entrypoint"]`. Otherwise, DevSpace will not know which command to restart.
251
251
:::
252
252
253
253
:::note When not to use this option
@@ -411,7 +411,6 @@ initialSync: mirrorLocal
411
411
```
412
412
413
413
#### Example: Configuring Initial Sync
414
-
<<<<<<< HEAD
415
414
416
415
```yaml
417
416
deployments:
@@ -434,7 +433,7 @@ dev:
434
433
**Explanation:**
435
434
With this configuration, `devspace dev` would do the following:
436
435
- DevSpace would start port-forwarding and file synchronzation.
437
-
- Initial sync would be started automatically.
436
+
- Initial sync is started automatically.
438
437
- The first sync config section would synchronize all files except files within `node_modules/`. This means that during initial sync, all remote files that are not existing locally would be deleted and other files would be updated to the most recent version.
439
438
- The second sync config section would only synchronize files within `node_modules/` and because of `initialSync: preferRemote`, DevSpace would download all remote files which are not present on the local filesystem and override all local files which are different than the files within the container.
440
439
@@ -503,8 +502,8 @@ dev:
503
502
upload: 100 # 100 KB/s
504
503
```
505
504
**Explanation:**
506
-
- Downloading files from the container to the local filesystem would be limited to a transfer speed of `200 KB/s`.
507
-
- Upload files from the local filesystem to the container would be limited to a transfer speed of `100 KB/s`.
505
+
- Downloading files from the container to the local filesystem is limited to a transfer speed of `200 KB/s`.
506
+
- Upload files from the local filesystem to the container is limited to a transfer speed of `100 KB/s`.
508
507
509
508
### `bandwidthLimits.upload`
510
509
The `bandwidthLimits.upload` option expects an integer representing the max file upload speed in KB/s, e.g. `upload: 100` would limit the file sync to a upload speed of `100 KB/s`.
@@ -520,7 +519,7 @@ By default, the file synchronization algorithm uses the maximum bandwidth possib
520
519
521
520
### `polling`
522
521
523
-
Polling specifies if the DevSpace helper should traverse over all watched files and folders periodically in the container to identify file changes. By default, DevSpace will use [inotify](https://man7.org/linux/man-pages/man7/inotify.7.html) to detect changes which is more efficient, however sometimes it might be unsupported or not feasible in certain situations, in which polling might be preferred.
522
+
Polling specifies if the DevSpace helper should traverse over all watched files and folders periodically in the container to identify file changes. By default, DevSpace uses [inotify](https://man7.org/linux/man-pages/man7/inotify.7.html) to detect changes. This can be more efficient, however, sometimes it might be unsupported or not feasible in certain situations, in which case, polling might be preferred.
0 commit comments