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-2025 by someone <someone@somenet.org>
   7 #
   8
   9 # vnStat 2.13 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 # show animation at the beginning of -l / --live line (1 = enabled, 0 = disabled)
  67 ;LiveSpinner 1
  68
  69 # default query mode
  70 # 0 = summary, 1 = days, 2 = months, 3 = top, 4 = single summary, 5 = short
  71 # 7 = hours graph, 8 = xml, 9 = one line, 10 = json, 11 = hours, 12 = 5 minute
  72 ;QueryMode 0
  73
  74 # default list output entry limits (0 = all)
  75 List5Mins      50
  76 ListHours      50
  77 ListDays       50
  78 ListMonths     50
  79 ListYears       0
  80 ListTop         0
  81
  82 # how to match interface given for query to interface in database
  83 # 0 = case sensitive exact match to interface name
  84 # 1 = method 0 followed by case sensitive exact match of alias
  85 # 2 = method 1 followed by case insensitive exact match of alias
  86 # 3 = method 2 followed by case insensitive beginning match of alias
  87 ;InterfaceMatchMethod 3
  88
  89 # visibility of estimate line and text used in it
  90 ;EstimateVisible 1
  91 ;EstimateText "estimated"
  92
  93 # interface order (0 = alphabetical by name, 1 = alphabetical by alias)
  94 ;InterfaceOrder 0
  95
  96
  97 # vnstatd
  98 ##
  99
 100 # switch to given user when started as root (leave empty to disable)
 101 ;DaemonUser ""
 102
 103 # switch to given group when started as root (leave empty to disable)
 104 ;DaemonGroup ""
 105
 106 # try to detect interface maximum bandwidth, 0 = disable feature
 107 # MaxBandwidth will be used as fallback value when enabled
 108 ;BandwidthDetection 1
 109
 110 # maximum bandwidth (Mbit) for all interfaces, 0 = disable feature
 111 # (unless interface specific limit is given)
 112 ;MaxBandwidth 1000
 113
 114 # interface specific limits
 115 #  example 8Mbit limit for eth0 (remove # to activate):
 116 #MaxBWeth0 8
 117
 118 # data retention durations (-1 = unlimited, 0 = feature disabled)
 119 5MinuteHours    1
 120 HourlyDays     -1
 121 DailyDays      -1
 122 MonthlyMonths  -1
 123 YearlyYears    -1
 124 TopDayEntries   1
 125
 126 # how often (in seconds) interface data is updated
 127 ;UpdateInterval 20
 128
 129 # how often (in seconds) interface status changes are checked
 130 ;PollInterval 5
 131
 132 # how often (in minutes) data is saved to database
 133 ;SaveInterval 5
 134
 135 # how often (in minutes) data is saved when all interface are offline
 136 ;OfflineSaveInterval 30
 137
 138 # rescan database after save for new interfaces to be monitored (1 = enabled, 0 = disabled)
 139 ;RescanDatabaseOnSave 1
 140
 141 # automatically start monitoring all interfaces not found in the database
 142 # (1 = enabled, 0 = disabled)
 143 ;AlwaysAddNewInterfaces 0
 144
 145 # on which day should months change
 146 ;MonthRotate 1
 147 ;MonthRotateAffectsYears 0
 148
 149 # filesystem disk space check (1 = enabled, 0 = disabled)
 150 ;CheckDiskSpace 1
 151
 152 # how much the boot time can variate between updates (seconds)
 153 ;BootVariation 15
 154
 155 # create database entries even when there is no traffic (1 = enabled, 0 = disabled)
 156 ;TrafficlessEntries 1
 157
 158 # how many minutes to wait during daemon startup for system clock to
 159 # sync time if most recent database update appears to be in the future
 160 ;TimeSyncWait 5
 161
 162 # how often (in minutes) bandwidth detection is done when
 163 # BandwidthDetection is enabled (0 = disabled)
 164 ;BandwidthDetectionInterval 5
 165
 166 # force data save when interface status changes (1 = enabled, 0 = disabled)
 167 ;SaveOnStatusChange 1
 168
 169 # enable / disable logging (0 = disabled, 1 = logfile, 2 = syslog)
 170 ;UseLogging 2
 171
 172 # create dirs if needed (1 = enabled, 0 = disabled)
 173 ;CreateDirs 1
 174
 175 # update ownership of files if needed (1 = enabled, 0 = disabled)
 176 ;UpdateFileOwner 1
 177
 178 # file used for logging if UseLogging is set to 1
 179 ;LogFile "/var/log/vnstat/vnstat.log"
 180
 181 # file used as daemon pid / lock file
 182 ;PidFile "/run/vnstat/vnstat.pid"
 183
 184 # 1 = 64-bit, 0 = 32-bit, -1 = old style logic, -2 = automatic detection
 185 ;64bitInterfaceCounters -2
 186
 187 # use SQLite Write-Ahead Logging mode (1 = enabled, 0 = disabled)
 188 ;DatabaseWriteAheadLogging 0
 189
 190 # change the setting of the SQLite "synchronous" flag
 191 # (-1 = auto, 0 = off, 1, = normal, 2 = full, 3 = extra)
 192 ;DatabaseSynchronous -1
 193
 194 # database uses UTC instead of local timezone (1 = enabled, 0 = disabled)
 195 ;UseUTC 0
 196
 197 # database maintenance (1 = enabled, 0 = disabled)
 198 ;VacuumOnStartup 1
 199 ;VacuumOnHUPSignal 1
 200
 201
 202 # vnstati
 203 ##
 204
 205 # title timestamp format
 206 ;HeaderFormat "%Y-%m-%d %H:%M"
 207
 208 # show hours with rate (1 = enabled, 0 = disabled)
 209 ;HourlyRate 1
 210
 211 # show rate in summary (1 = enabled, 0 = disabled)
 212 ;SummaryRate 1
 213
 214 # transparent background (1 = enabled, 0 = disabled)
 215 ;TransparentBg 0
 216
 217 # image size control
 218 ;LargeFonts 0
 219 ;LineSpacingAdjustment 0
 220 ;ImageScale 100
 221
 222 # 5 minutes graph size control
 223 ;5MinuteGraphResultCount 576
 224 ;5MinuteGraphHeight 300
 225
 226 # hourly graph mode (0 = 24 hour sliding window, 1 = begins from midnight)
 227 ;HourlyGraphMode 0
 228
 229 # horizontal/vertical summary graph (0 = hours, 1 = 5 minutes)
 230 ;SummaryGraph 0
 231
 232 # traffic estimate bar style
 233 # (0 = not shown, 1 = continuation of existing bar, 2 = separate bar)
 234 ;EstimateStyle 1
 235
 236 # bar column in list outputs shows rate if OutputStyle is 3
 237 # (1 = enabled, 0 = disabled)
 238 ;BarColumnShowsRate 0
 239
 240 # image colors
 241 ;CBackground     "FFFFFF"
 242 ;CEdge           "AEAEAE"
 243 ;CHeader         "606060"
 244 ;CHeaderTitle    "FFFFFF"
 245 ;CHeaderDate     "FFFFFF"
 246 ;CText           "000000"
 247 ;CLine           "B0B0B0"
 248 ;CLineL          "-"
 249 ;CPercentileLine "CF0045"
 250 ;CRx             "92CF00"
 251 ;CTx             "606060"
 252 ;CRxD            "-"
 253 ;CTxD            "-"
 254 ;CTotal          "0098CF"