FoxGate+ AntiVPN v1.0.9-pre6

#      ___      _        _
#     /   \__ _| |_ __ _| |__   __ _ ___  ___
#    / /\ / _` | __/ _` | '_ \ / _` / __|/ _ \
#   / /_// (_| | || (_| | |_) | (_| \__ \  __/
#  /___,' \__,_|\__\__,_|_.__/ \__,_|___/\___|
#
# Configure a database for use.
#
# ❓ Has questions? Join to the discord server:
# - https://discord.zowi.gay/
# - https://discord.idcteam.xyz/
database:

    # ⚙ Determine the type of DataBase will be used.
    # - Available options in type.
    #   All options use HikariCP for better performance.
    #
    #  |=> MySQL
    #  |=> MariaDB
    #  |=> PostgreSQL
    #  |=> SQLite (COULD CAUSE ISSUES IN OLDER VERSIONS!)
    #  |=> H2
    #  |=> JayBird
    #  |=> Custom
    #
    #  -----------------------------------------------------------------------------
    #      Type   |   Stability | Performance | Support | Popularity | Concurrence |
    #  -----------------------------------------------------------------------------
    #    MariaDB      |      4⭐     |     4⭐      |    5⭐   |     5⭐     |     5⭐
    #     MySQL   |      4⭐     |     4⭐      |    5⭐   |     5⭐     |     4⭐
    #   PostgreSQL |      5⭐        |     5⭐      |    4⭐   |     3⭐     |     5⭐
    #    SQLite   |      1⭐        |     3⭐     |    3⭐  |     2⭐    |     4⭐
    #       H2    |      2⭐     |     4⭐      |    3⭐   |     2⭐     |     1⭐
    #     Jaybird  |      2⭐        |     2⭐      |    1⭐   |     1⭐     |     1⭐
    #
    # 📚 Note: In case you change this configuration and your server is
    # already started, use the command "/foxgate db reconnect" to restart
    # your database without restarting plugin or server. Always remember do
    # "/foxgate reload" before using this command to apply.
    type: H2

    # 🔩 Set the table's name inside the DataBase.
    # - Modify in case you want mantain older stats while using another
    #   new. This can also help in case a conflict occurrs.
    #
    # 📚 Note: If you want restore older stats used in Older versions
    # of FoxGate (1.0.5-pre4 or older), use the next:
    #   - 'vpn_cache'
    table: foxgate

    # 🔩 Save the cache inside the database instead of a file?
    # - Use this only if you want to use multi-proxy or you're sure
    #   this will don't cause problems with your database.
    #
    # 📚 Note: Custom databases are partially supported in this feature.
    cache_database: false

    # 🔩 Enable whitelist based in DataBase?
    # - Set this feature to enabled in case you want to save
    #   whitelist IP's/names in a database instead of a file.
    #   Extremely recommended for Multi-Proxy.
    #
    # 📚 Note: Custom databases are partially supported in this feature.
    whitelist_database: false

#  __                 _
# / _\ ___ _ ____   _(_) ___ ___ ___
# \ \ / _ | '__\ \ / | |/ __/ _ / __|
# _\ |  __| |   \ V /| | (_|  __\__ \
# \__/\___|_|    \_/ |_|\___\___|___/
#
# The configuration is generated with our File Manager,
# which overrides the real comments. See the description of
# every available services in our GitHub repository of
# issues and wiki.
#
# 💼 GitHub:
# https://github.com/IDCTeam-Group/FoxGate-Issues/wiki/Services
#
# 📚 Note: Use 'Ctrl+F' to search the service, and put the file
# name for search more easy. ^^

# 🔩 Enable this service?
enabled: true
# 🔑 Add this field in case require key.
# - This is used for '{KEY}' variable in the
#   headers or URL fields.
key: ''
# 🔗 The plugin should output errors though
#    the console?
# - Enable this option if you want get output
#   in case a service give errors in the console.
#   Useful for debug responses while debugging it's
#   disabled.
#
# 📚 Note: This only works in certain scenearies, like
# an API returning 'nullable' value or another.
output_errors: true

# 📚 Model of the response.
# - Add the model to handle the response of
#   the API. Check the response type and set one
#   correctly for making this works properly.
#
# 📁 Supported values:
# - HTML
# - JSON
# - CONTAINS
model: JSON
# 🚩 Flags to add when it's detected in this service.
# - Option for add more VLs to reach the maxFlags
#   in each services. Useful if you trust in a service
#   and want make it count more VLs.
vls: '2'
# 🔗 URL of the API.
# - This field is important, insert the URL of
#   the service for response.
#
# 📁 Supported placeholders:
# - {IP} - Return the player's IP.
# - {KEY} - Return 'key' field value.
url: https://central.zowi.gay/check/{IP}
# ⛓ Headers to use.
# - Set custom headers in case it's required.
#   The values can be in List or Map.
#
# 📚 Note: Set to '[]' or '{}' to disable.
headers: {
    }

# 💡 Values to check.
values:

    # 🧩 Fields to check.
    # - Disable the fields to check with using
    #   the value '{}'. If you exclude this value,
    #   field 'type' will check if the final
    #   response contains that value.
    fields:
    - security.vpn
    - security.proxy
    - security.hosting
    - security.residential_proxy
    - security.tor
    # 🚩 Type to determine.
    # - Determine which value needs to determine
    #   if the connection it's a VPN/Proxy or another,
    #   this will check for a String.
    #
    # 📚 Note: Use 'boolean' for check for any boolean
    # boolean, like: 'true'/'false' or '0'/'1'.
    type: boolean

    # 📚 Custom conditions to determine bypass or detection logic.
    # - These conditions allow advanced control based on fields from the
    #   API response.
    #
    # 📁 Structure:
    # - Each key (e.g. '1', '2', etc.) holds a list of conditions.
    # - Each list works with AND logic (all conditions must match).
    # - Multiple keys result in OR logic (at least one group must match).
    #
    # 🧩 Syntax:
    # - Use {field} to refer to response fields (e.g. {score}).
    # - Supported operators: '=', '!=', '>', '>=', '<', '<='.
    # - Values can be strings (true/false) or numbers.
    #
    # 📚 Note: This feature only works in 'JSON' and 'HTML' type,
    # and for make this works in HTML, always use '{foxgate_check}' for
    # use field (only exists this in HTML).
    conditions:

        # 💼 Conditions for Bypass
        # - If any group of conditions here matches, the player will be
        #   ignored (not flagged). Use this for trusted connections like mobile
        #   users or low score in risk/fraud.
        #
        # 📚 Note: Disable this condition with 'bypass: {}'.
        bypass: {
            }

        # 🚩 Conditions for Flag.
        # - If any group of conditions here matches, the player will
        #   be flagged (detected). Useful for detecting based on high
        #   risk/fraud score, known abuse, etc.
        #
        # 📚 Note: Disable this condition with 'flag: {}'.
        flag: {
            }

#   _____  ___  __ _           _ _
#   \_   \/ _ \/ /(_)_ __ ___ (_| |_ ___ _ __
#    / /\/ /_)/ / | | '_ ` _ \| | __/ _ | '__|
# /\/ /_/ ___/ /__| | | | | | | | ||  __| |
# \____/\/   \____|_|_| |_| |_|_|\__\___|_|
#
# Limit maximum connections per IP to avoid multi-accounts
# or bots.
# When a player join, this start a count in their IP, where
# a new connection in the IP it's 1 point more, and if
# that IP reachs a certain amount of points, the connection
# will be denied. But, if the player leave the server, the IP
# discount 1 point.
#
# 📚 Note: This feature it's experimental and could be unstable
# in some cases, try using this with precaution. Every update,
# this tries to be more stable while tries to be optimized.
#
# ❓ Has questions? Join to the discord server:
# - https://discord.zowi.gay/
# - https://discord.idcteam.xyz/

# 📁 Enable this feature?
enable: true

# 👤 Determine the maximum limit of points per
# IP to start blocking coming new connections
# from that IP.
# - Avoid using a low value, because exists rare
#   cases where an user joins with a duplicate IP
#   in the same city from same provider of ISP.
#
# ⭐ Recommended: 3
maximum: 3
# ⏳ Base in time.
# - When enabled, the IP counter will automatically reset
#   after the specified time period. This prevents permanent
#   IP blocks and allows users from the same network
#   (like family, school, or workplace) to join again
#   after the time expires.
#
#   With '30m' and maximum=3: If 3 players from the same
#   IP join within 30 minutes, the 4th will be blocked.
#   After 30 minutes, the counter resets to 0.
#   If the module it's disabled, the counter never resets
#   automatically, only will allow if one player leaves the
#   server, this discount 1 from the counter and the 4th
#   can enter.
#
# ⭐ Recommended: 30m
# 📚 Note: Use 'DISABLE' for disable this feature.
time: DISABLE

# ✨ Download known malicious ASN's list.
# - Uses Zowi's Central for download a list of known
#   malicious ASN's for blocking, available only for
#   buyers and original plugin.
#
# 📚 Note: You can report for add a malicious or removing
# a false flagged ASN. Some ISP's blocked in this
# feature, are for bad reputation or for providing
# hosting/VPN.
known:

    # 🚩 Enable this feature?
    enable: true
    # ⌛ Time (in hours) to scanning for downloading new
    # information about known ASN's list.
    # - Buyers can help in report known malicious ASN's and
    #   save in a list, which everyone with Plus Edition can
    #   download and prevent more VPN's, Bot's, and others stuff.
    #
    #   ➡ Use 'DISABLE' for disable the update.
    time: '2'
    # 🌎 Include all suspecious ISPs?
    # - This option will includes some suspecious ISPs for
    #   VPNs, Tor, Proxies and others, useful for making strict
    #   detections but can make false flags. This feature
    #   works with 'excluded' option.
    #
    # 📚 Note: Ask to our discord server for the list in case
    # you want only block specifies.
    suspecious_isps: false

    # 🧰 External provider.
    # - Use this option in case you want use another external
    #   list of ASNs. The plugin tries to handle it and update
    #   it.
    #   ⚠ Requeriments:
    #     - Needs to be a JSON(5) format.
    #     - Needs to be HTTPS always.
    #     - Needs to return file size in header (avoid issues, If isn't raw).
    #     - Needs to return status 200.
    #     - Needs to be a dowloadable file in output (If isn't raw).
    #     - Needs to be a array-json format only.
    #
    # 📚 Note: Supports JSON5, but requires to be a JSON format,
    # without a JSON5 feature (plugin uses Gson for load and cache).
    # ➡ https://discord.zowi.gay/
    provider:

        # 📁 Enable this feature?
        # - This feature will break options like 'suspeciois_isps'
        #   and in case you bought Extended ASN List, this doesn't
        #   will be applied. All options mentioned before, are only
        #   available in the original provider, using another provider
        #   only will be used their content of ASN List.
        #
        # ⚠ Warning: FoxGate will try to remove important data from the
        # headers while using this option for prevent malicious actors,
        # it's always recommended use original provider. USE THIS AT YOUR
        # RISK WHILE USING THIS IN UNTRUSTED SOURCES!
        enabled: false
        # 🔗 URL to get the downloadable/raw file.
        # - Follow all requeriments attached above first
        #   for enabling provider. Leaving this empty will
        #   make the feature non-functional.
        url: ''

    # 💼 Exclude ASN's from the known list in case one
    # give's false flags to you.
    #
    # 📚 Note: You can request for removing in case it's
    # a false flag.
    excluded: []

#    __          _        _      _           _
#   /__\ ___ ___| |_ _ __(_) ___| |_ ___  __| |
#  / \/// _ / __| __| '__| |/ __| __/ _ \/ _` |
# / _  |  __\__ | |_| |  | | (__| ||  __| (_| |
# \__\_/\___|___/\__|_|  |_|\___|\__\___|\__,_|
# / _\ ___ _ ____   _____ _ __ ___
# \ \ / _ | '__\ \ / / _ | '__/ __|
# _\ |  __| |   \ V |  __| |  \__ \
# \__/\___|_|    \_/ \___|_|  |___/
#
# Limit which subservers from your proxy, blocked users can
# join or not.
# When a player get detected but this feature it's enabled,
# the player can log-in correctly without getting denied,
# allowing the connection to certains subservers/backends in
# your Proxy. This is useful in case you want players can
# join to your hub but no in games-mode.
#
#    🚩 This is feature it's available only for:
#    ➡ BungeeCord
#    ➡ Velocity
#    ➡ WaterdogPE
#
# 📚 Note: If you enable this feature but the server isn't
# in the list, the player probably can join without getting
# denined in certain scenaries.
# 🚩 Warning! This feature requires option 'scanner.block.cache'
# from 'config.yml' enabled. Why? We aiming in reducing
# database calls to prevent bot-attacks and saving performance,
# this it's a better way.
#
# ❓ Has questions? Join to the discord server:
# - https://discord.zowi.gay/
# - https://discord.idcteam.xyz/

# 📁 Enable this feature?
enable: false

# 🧰 Define the type of usage to this list.
# - 'whitelist': Allow the access to certain servers.
# - 'blacklist': Deny the access in certain servers.
type: whitelist
# 📍 Add the list of servers names for block/allow connections.
# - Uses RegEx if you needs. The list of under, only was
#   examples using RegEx, you can change with your servers
#   names (the name used for connect the proxy to backends).
#
# 📚 Note: If you leave whitelist/blacklist type and this is
# empty, will disable the feature.
list:
- auth.*
- lobby.*