]> git.somenet.org - root/pub/somesible.git/blob - roles/base/network/files/default/vnstat.conf
roles/base/backup/files
[root/pub/somesible.git] / roles / base / network / files / default / vnstat.conf
1 #
2 ################################################
3 ### Managed by someone's ansible provisioner ###
4 ################################################
5 # Part of: https://git.somenet.org/root/pub/somesible.git
6 # 2017-2024 by someone <someone@somenet.org>
7 #
8
9 # vnStat 2.10 configuration file
10 #
11 # lines starting with # or ; are comments, everything has default
12 # values, remove ; before each option to change its value
13
14
15 # default interface (leave empty for automatic selection)
16 ;Interface ""
17
18 # location of the database directory
19 ;DatabaseDir "/var/lib/vnstat"
20
21 # locale (LC_ALL) ("-" = use system locale)
22 ;Locale "-"
23
24 # date output formats for -d, -m, -t and -w
25 ;DayFormat    "%Y-%m-%d"
26 ;MonthFormat  "%Y-%m"
27 ;TopFormat    "%Y-%m-%d"
28
29 # characters used for visuals
30 ;RXCharacter       "%"
31 ;TXCharacter       ":"
32 ;RXHourCharacter   "r"
33 ;TXHourCharacter   "t"
34
35 # how units are prefixed when traffic is shown
36 # 0 = IEC standard prefixes (KiB/MiB/GiB...)
37 # 1 = old style binary prefixes (KB/MB/GB...)
38 # 2 = SI decimal prefixes (kB/MB/GB...)
39 ;UnitMode 0
40
41 # used rate unit (0 = bytes, 1 = bits)
42 ;RateUnit 1
43
44 # how units are prefixed when traffic rate is shown in bits
45 # 0 = IEC binary prefixes (Kibit/s...)
46 # 1 = SI decimal prefixes (kbit/s...)
47 ;RateUnitMode 1
48
49 # output style
50 # 0 = minimal & narrow, 1 = bar column visible
51 # 2 = same as 1 except rate in summary
52 # 3 = rate column visible
53 ;OutputStyle 3
54 ;EstimateBarVisible 1
55
56 # number of decimals to use in outputs
57 ;DefaultDecimals 2
58 ;HourlyDecimals 1
59
60 # spacer for separating hourly sections (0 = none, 1 = '|', 2 = '][', 3 = '[ ]')
61 ;HourlySectionStyle 2
62
63 # how many seconds should sampling for -tr take by default
64 ;Sampletime 5
65
66 # default query mode
67 # 0 = normal, 1 = days, 2 = months, 3 = top, 5 = short
68 # 7 = hours, 8 = xml, 9 = one line, 10 = json
69 ;QueryMode 0
70
71 # default list output entry limits (0 = all)
72 List5Mins      50
73 ListHours      50
74 ListDays       50
75 ListMonths     50
76 ListYears       0
77 ListTop         0
78
79 # how to match interface given for query to interface in database
80 # 0 = case sensitive exact match to interface name
81 # 1 = method 0 followed by case sensitive exact match of alias
82 # 2 = method 1 followed by case insensitive exact match of alias
83 # 3 = method 2 followed by case insensitive beginning match of alias
84 ;InterfaceMatchMethod 3
85
86 # visibility of estimate line and text used in it
87 ;EstimateVisible 1
88 ;EstimateText "estimated"
89
90
91 # vnstatd
92 ##
93
94 # switch to given user when started as root (leave empty to disable)
95 ;DaemonUser ""
96
97 # switch to given group when started as root (leave empty to disable)
98 ;DaemonGroup ""
99
100 # try to detect interface maximum bandwidth, 0 = disable feature
101 # MaxBandwidth will be used as fallback value when enabled
102 ;BandwidthDetection 1
103
104 # maximum bandwidth (Mbit) for all interfaces, 0 = disable feature
105 # (unless interface specific limit is given)
106 ;MaxBandwidth 1000
107
108 # interface specific limits
109 #  example 8Mbit limit for eth0 (remove # to activate):
110 #MaxBWeth0 8
111
112 # data retention durations (-1 = unlimited, 0 = feature disabled)
113 5MinuteHours    1
114 HourlyDays     -1
115 DailyDays      -1
116 MonthlyMonths  -1
117 YearlyYears    -1
118 TopDayEntries   1
119
120 # how often (in seconds) interface data is updated
121 ;UpdateInterval 20
122
123 # how often (in seconds) interface status changes are checked
124 PollInterval 10
125
126 # how often (in minutes) data is saved to database
127 ;SaveInterval 5
128
129 # how often (in minutes) data is saved when all interface are offline
130 ;OfflineSaveInterval 30
131
132 # rescan database after save for new interfaces to be monitored (1 = enabled, 0 = disabled)
133 ;RescanDatabaseOnSave 1
134
135 # automatically start monitoring all interfaces not found in the database
136 # (1 = enabled, 0 = disabled)
137 ;AlwaysAddNewInterfaces 0
138
139 # on which day should months change
140 ;MonthRotate 1
141 ;MonthRotateAffectsYears 0
142
143 # filesystem disk space check (1 = enabled, 0 = disabled)
144 ;CheckDiskSpace 1
145
146 # how much the boot time can variate between updates (seconds)
147 ;BootVariation 15
148
149 # create database entries even when there is no traffic (1 = enabled, 0 = disabled)
150 ;TrafficlessEntries 1
151
152 # how many minutes to wait during daemon startup for system clock to
153 # sync time if most recent database update appears to be in the future
154 ;TimeSyncWait 5
155
156 # how often (in minutes) bandwidth detection is done when
157 # BandwidthDetection is enabled (0 = disabled)
158 ;BandwidthDetectionInterval 5
159
160 # force data save when interface status changes (1 = enabled, 0 = disabled)
161 ;SaveOnStatusChange 1
162
163 # enable / disable logging (0 = disabled, 1 = logfile, 2 = syslog)
164 ;UseLogging 2
165
166 # create dirs if needed (1 = enabled, 0 = disabled)
167 ;CreateDirs 1
168
169 # update ownership of files if needed (1 = enabled, 0 = disabled)
170 ;UpdateFileOwner 1
171
172 # file used for logging if UseLogging is set to 1
173 ;LogFile "/var/log/vnstat/vnstat.log"
174
175 # file used as daemon pid / lock file
176 ;PidFile "/run/vnstat/vnstat.pid"
177
178 # 1 = 64-bit, 0 = 32-bit, -1 = old style logic, -2 = automatic detection
179 ;64bitInterfaceCounters -2
180
181 # use SQLite Write-Ahead Logging mode (1 = enabled, 0 = disabled)
182 DatabaseWriteAheadLogging 1
183
184 # change the setting of the SQLite "synchronous" flag
185 # (-1 = auto, 0 = off, 1, = normal, 2 = full, 3 = extra)
186 ;DatabaseSynchronous -1
187
188 # database uses UTC instead of local timezone (1 = enabled, 0 = disabled)
189 ;UseUTC 0
190
191
192 # vnstati
193 ##
194
195 # title timestamp format
196 ;HeaderFormat "%Y-%m-%d %H:%M"
197
198 # show hours with rate (1 = enabled, 0 = disabled)
199 ;HourlyRate 1
200
201 # show rate in summary (1 = enabled, 0 = disabled)
202 ;SummaryRate 1
203
204 # transparent background (1 = enabled, 0 = disabled)
205 ;TransparentBg 0
206
207 # image size control
208 ;LargeFonts 0
209 ;LineSpacingAdjustment 0
210 ;ImageScale 100
211
212 # 5 minutes graph size control
213 ;5MinuteGraphResultCount 576
214 ;5MinuteGraphHeight 300
215
216 # hourly graph mode (0 = 24 hour sliding window, 1 = begins from midnight)
217 ;HourlyGraphMode 0
218
219 # horizontal/vertical summary graph (0 = hours, 1 = 5 minutes)
220 ;SummaryGraph 0
221
222 # traffic estimate bar style
223 # (0 = not shown, 1 = continuation of existing bar, 2 = separate bar)
224 ;EstimateStyle 1
225
226 # bar column in list outputs shows rate if OutputStyle is 3
227 # (1 = enabled, 0 = disabled)
228 ;BarColumnShowsRate 0
229
230 # image colors
231 ;CBackground     "FFFFFF"
232 ;CEdge           "AEAEAE"
233 ;CHeader         "606060"
234 ;CHeaderTitle    "FFFFFF"
235 ;CHeaderDate     "FFFFFF"
236 ;CText           "000000"
237 ;CLine           "B0B0B0"
238 ;CLineL          "-"
239 ;CRx             "92CF00"
240 ;CTx             "606060"
241 ;CRxD            "-"
242 ;CTxD            "-"