· 6 years ago · Jan 06, 2020, 05:06 PM
1# How the plugin stores long-term data
2storage:
3 # The storage method
4 #
5 # Options:
6 # - MySQL (remote)
7 # - SQLite (local)
8 method: 'sqlite'
9
10 data:
11 # Address and port of the remote database (if applicable)
12 address: '127.0.0.1:3306'
13 # The name of the database Anti-VPN will store data in
14 # If you're using remote options, this must be created beforehand
15 database: 'avpn'
16 # Table prefix for all Anti-VPN tables
17 prefix: 'antivpn_'
18 # Database credentials (if applicable)
19 username: ''
20 password: ''
21 # Whether or not to use SSL
22 ssl: false
23
24 # MongoDB options- obviously don't need to worry about these if not using MongoDB ;)
25 mongodb:
26 # Connection prefix for all Anti-VPN connections
27 collection-prefix: ''
28 # MongoDB ClientConnectionURI
29 connection-uri: ''
30
31 settings:
32 # The maximum size of the database connection pool
33 # Determines the max number of connections to the database
34 max-pool-size: 2
35 # The minimum size of the satabase connection pool
36 # Determines the min number of connections kept alive to the database
37 min-idle: 2
38 # The maximum lifetime of a connection in the pool
39 # Should be at least 30 seconds less than any database or infrastructure-imposed connection time limit
40 max-lifetime: 1800000 # 30 minutes
41 # The maximum number of milliseconds that the plugin will wait for a new connection from the pool before timing out
42 timeout: 5000 # 5 seconds
43
44 # Extra connection properties
45 properties:
46 unicode: true
47 encoding: 'utf8'
48
49# Redis is a very fast cache accessible by multiple servers
50# If you don't want to constantly hit your database for queries, try enabling and configuring this
51# You will need to install the (external) Redis server software if you haven't already
52# https://redis.io/
53redis:
54 enabled: false
55 # Address and port of the remote Redis server
56 address: '127.0.0.1:6379'
57 # Redis credentials
58 password: ''
59
60# RabbitMQ is a messaging queue that will allow the plugin to push instant updates across multiple servers
61# You will need to install the (external) RabbitMQ server software if you haven't already
62# https://www.rabbitmq.com/
63rabbitmq:
64 enabled: false
65 # Address and port of the remote RabbitMQ server
66 address: '127.0.0.1:5672'
67 # RabbitMQ credentials
68 username: 'guest'
69 password: 'guest'
70
71# Where VPN-checking sources are defined
72# Beware the more sources that are included (and fail) the worse the performance and the more the lag
73sources:
74 # The amount of time to globally cache results across all sources
75 # This should be as high as possible to avoid rate-limits but as low as possible to ensure results are always up-to-date and accurate
76 cacheTime: '6hours'
77
78 # The order to try results in
79 order:
80 - 'iphub'
81 - 'proxycheck'
82 - 'iphunter'
83 - 'getipintel'
84 - 'ipqualityscore'
85 - 'vpnblocker'
86 - 'ip2proxy'
87 - 'teoh'
88 - 'shodan'
89 - 'ipwarner'
90
91 # https://iphub.info/
92 # Results updated Jul 7, 2019
93 # Error rate: 0%
94 # NordVPN detection rate: 85.71%
95 # Cryptostorm detection rate: 100%
96 # False-flagged homes: 0%
97 iphub:
98 enabled: false
99 # API key to use (Required for this service, free one available at https://iphub.info/apiKey/newFree )
100 key: ''
101 # The block type at which an IP is considered "bad"
102 block: 1
103
104 # https://proxycheck.io
105 # Results updated Jul 7, 2019
106 # Error rate: 0%
107 # NordVPN detection rate: 80.95%
108 # Cryptostorm detection rate: 100%
109 # False-flagged homes: 0%
110 proxycheck:
111 enabled: true
112 # Optional API key to use
113 key: '4732z7-958296-cu61fs-858778'
114
115 # https://www.iphunter.info/
116 # Results updated Jul 7, 2019
117 # Error rate: 0%
118 # NordVPN detection rate: 95.24%
119 # Cryptostorm detection rate: 90%
120 # False-flagged homes: 40%
121 iphunter:
122 enabled: false
123 # API key to use (Required for this service, free one available at https://www.iphunter.info/user/register )
124 key: ''
125 # The block type at which an IP is considered "bad"
126 block: 1
127
128 # https://www.getipintel.net/
129 # Results updated Sep 6, 2018
130 # Error rate: 5%
131 # NordVPN detection rate: 90.48%
132 # Cryptostorm detection rate: 100%
133 # False-flagged homes: 40%
134 getipintel:
135 enabled: false
136 # Contact e-mail in case things go wrong. Required
137 contact: 'admin@yoursite.com'
138 # Threshold above which an IP is considered "bad"
139 threshold: 0.98
140
141 # https://www.ipqualityscore.com/
142 # Results updated Jul 7, 2019
143 # Error rate: 0%
144 # NordVPN detection rate: 90.48%
145 # Cryptostorm detection rate: 90%
146 # False-flagged homes: 40%
147 ipqualityscore:
148 enabled: false
149 # API key to use (Required for this service, free one available at https://www.ipqualityscore.com/create-account )
150 key: ''
151 # Threshold above which an IP is considered "bad"
152 threshold: 0.65
153
154 # https://vpnblocker.net/usage
155 # Results updated Jul 7, 2019
156 # Error rate: 0%
157 # NordVPN detection rate: 66.67%
158 # Cryptostorm detection rate: 95%
159 # False-flagged homes: 10%
160 vpnblocker:
161 enabled: false
162 # Optional API key to use
163 key: ''
164
165 # https://www.ip2location.com/web-service/ip2proxy
166 # Results updated Jul 18, 2019
167 # Error rate: 0%
168 # NordVPN detection rate: 100%
169 # Cryptostorm detection rate: 60%
170 # False-flagged homes: 0%
171 ip2proxy:
172 enabled: false
173 # API key to use (Required for this service, free one available using 'demo' or at https://www.ip2location.com/register?id=1006 )
174 key: 'demo'
175
176 # https://ip.teoh.io/vpn-detection
177 # Results updated Jul 7, 2019
178 # Error rate: 10%
179 # NordVPN detection rate: 61.90%
180 # Cryptostorm detection rate: 100%
181 # False-flagged homes: 0%
182 teoh:
183 enabled: false
184
185 # https://www.shodan.io/
186 # Results updated Jul 7, 2019
187 # Error rate: 94.52%
188 # NordVPN detection rate: 95.24%
189 # Cryptostorm detection rate: 60%
190 # False-flagged homes: 0%
191 shodan:
192 enabled: false
193 # API key to use (Required for this service)
194 key: ''
195
196 # https://ipwarner.com/
197 ipwarner:
198 enabled: false
199 # API key to use (Required for this service, free one available at https://ipwarner.com/register )
200 key: ''
201
202action:
203 # The kick message to display to players who are using VPNs
204 # If left blank, will not kick the player
205 kick-message: '&cPlease disconnect from your proxy or VPN before re-joining!'
206 # The command that CONSOLE will run for players who are using VPNs
207 # Use %player% as a placeholder for the player's (real) name
208 # Use %uuid% as a placeholder for the player's uuid
209 # If left blank, will not run anything
210 command: ''
211
212 algorithm:
213 # The algorithm method
214 #
215 # Options:
216 # - Cascade
217 # The plugin will go down the "sources" list, sequentially, until a valid source is found
218 # It will then query that source and return the result
219 # This will result in essentially "the first valid result" being returned
220 # - Consensus
221 # The plugin will try every source in the "sources" list at once
222 # It will then strip invalid results, and calculate the ratio of results from the remaining sources
223 # This will result in essentially "the ratio of valid results" being returned
224 method: 'cascade'
225
226 # Only used for "consensus" mode
227 # The minimum ratio of APIs that must agree before a player is kicked
228 # For example, if set to "0.6" then at least 60% of sources must agree that the IP is a VPN
229 # The value can range from 0 to 1, and will be clipped at those values
230 min-consensus: 0.6
231
232 # IPs to ignore when checking for VPNs
233 ignore:
234 - '127.0.0.1'
235 - 'localhost'
236 - '::1'
237
238# The amount of time to cache lookups in-memory
239# Higher values require more memory
240# Lower values will hit Redis/SQL/APIs more frequently
241# Generally the default is good enough to prevent many sequential lookups from choking resources, but still keep memory usage low
242cacheTime: '1minute'
243# When true, logs some extra output to the console so you can see if/why things might be failing
244debug: false
245# The number of threads to use for web operations
246threads: 4
247
248stats:
249 # Whether or not to send anonymous usage statistics to bStats
250 # True: Send anonymous stats; let the author know how well the plugin is doing and how it's used!
251 # False: Do not send stats and make the author sad :(
252 usage: true
253 # Whether or not to send anonymous errors to the author
254 # True: Send errors anonymously to Rollbar and/or GameAnalytics so the author can fix them!
255 # False: Do not send errors and wonder why any bugs you encounter haven't beeen fixed
256 errors: true
257
258update:
259 # Whether or not to automatically check for updates and notify the console if found
260 check: true
261 # Whether or not to notify players with the avpn.admin permission node
262 notify: true
263
264# Config version, no touchy plz
265version: 3.9