Skip to content

Commit 746ed53

Browse files
authored
Remove old settings & move write_limit, download_limit to corresponding categories (#171)
1 parent 63e97ca commit 746ed53

File tree

1 file changed

+35
-13
lines changed

1 file changed

+35
-13
lines changed

docs/wings/optional-config.mdx

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -79,27 +79,49 @@ docker:
7979

8080
You can use these settings to adjust or completely disable throttling.
8181

82-
| Setting Key | Default Value | Notes |
83-
| :-------------------- | :-----------: | ----------------------------------------------------------------------------------------------------------------------------------- |
84-
| enabled | true | Whether or not the throttler is enabled |
85-
| lines | 2000 | Total lines that can be output in a given line_reset_interval period |
86-
| maximum_trigger_count | 5 | Amount of times throttle limit can be triggered before the server will be stopped |
87-
| line_reset_interval | 100 | The amount of time after which the number of lines processed is reset to 0 |
88-
| decay_interval | 10000 | Time in milliseconds that must pass without triggering throttle limit before trigger count is decremented |
89-
| stop_grace_period | 15 | Time that a server is allowed to be stopping for before it is terminated forcefully if it triggers output throttle |
90-
| write_limit | 0 | Impose I/O write limit for backups to the disk, 0 = unlimited. Value greater than 0 throttles write speed to the set value in MiB/s |
91-
| download_limit | 0 | Impose a Network I/O read limit for archives, 0 = unlimited. Value greater than 0 throttles read speed to the set value in MiB/s |
82+
| Setting Key | Default Value | Notes |
83+
| :-------------------- | :-----------: | ---------------------------------------------------------------------------|
84+
| enabled | true | Whether or not the throttler is enabled |
85+
| lines | 2000 | Total lines that can be output in a given line_reset_interval period |
86+
| line_reset_interval | 100 | The amount of time after which the number of lines processed is reset to 0 |
9287

9388
### Example of usage
9489

9590
```yml
9691
throttles:
9792
enabled: true
9893
lines: 2000
99-
maximum_trigger_count: 5
10094
line_reset_interval: 100
101-
decay_interval: 10000
102-
stop_grace_period: 15
95+
```
96+
97+
## Backups Limits
98+
99+
You can use these settings to adjust or completely disable throttling.
100+
101+
| Setting Key | Default Value | Notes |
102+
| :-------------------- | :-----------: | ------------------------------------------------------------------------------------------------------------------------------------|
103+
| write_limit | 0 | Impose I/O write limit for backups to the disk, 0 = unlimited. Value greater than 0 throttles write speed to the set value in MiB/s |
104+
105+
### Example of usage
106+
107+
```yml
108+
backups:
109+
write_limit: 0
110+
```
111+
112+
## Transfers Limits
113+
114+
You can use these settings to adjust or completely disable throttling.
115+
116+
| Setting Key | Default Value | Notes |
117+
| :-------------------- | :-----------: | ------------------------------------------------------------------------------------------------------------------------------------|
118+
| download_limit | 0 | Impose a Network I/O read limit for archives, 0 = unlimited. Value greater than 0 throttles read speed to the set value in MiB/s |
119+
120+
### Example of usage
121+
122+
```yml
123+
transfers:
124+
download_limit: 0
103125
```
104126

105127
## Installer Limits

0 commit comments

Comments
 (0)