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/configuration.md
+3-8Lines changed: 3 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,15 +21,13 @@ This section contains feature flags that control which of the tool's features ar
21
21
22
22
#### `show_log_locally`
23
23
24
-
TODO: Confirm this section
25
-
If set to `true`, the tool will output logs to a `debug.log` file at the root of the project directory. This is useful for debugging purposes. If set to `false`, logs will not be saved locally.
24
+
If set to `true`, the tool will output logs to the terminal.
26
25
27
26
When deploying to AWS, this should be set to `false` to avoid files being written to the local filesystem.
28
27
29
28
#### `write_data_locally`
30
29
31
-
TODO: Update this section
32
-
If set to `true`, the tool will use the local configuration file (`config.json`) for its settings (overriding any cloud configuration). If set to `false`, the tool will fetch the configuration from the cloud (S3 bucket).
30
+
If set to `true`, the tool will skip writing to S3 and instead write data for copilot teams, historic usage, and teams history to `local_data`.
33
31
34
32
**When deploying to AWS, this must be set to `false` to ensure the tool writes to AWS.**
35
33
@@ -48,9 +46,6 @@ When testing locally, you might set the `config.json` file as follows:
48
46
}
49
47
```
50
48
51
-
TODO: Confirm
52
-
This will ensure that the local configuration is used, logs are saved to `debug.log`, and no notifications are created during testing.
53
-
54
49
### Example On AWS
55
50
56
51
When deploying to AWS, the `config.json` file should be set as follows:
@@ -64,6 +59,6 @@ When deploying to AWS, the `config.json` file should be set as follows:
64
59
}
65
60
```
66
61
67
-
This configuration ensures that the tool does not log or write data locally
62
+
This configuration ensures that the tool does not log or write data locally.
68
63
69
64
**It is essential that `write_data_locally` is set to `false` when deploying to AWS.**
0 commit comments