From 8432533f43acc573c5a415a36b38b5dab695781f Mon Sep 17 00:00:00 2001 From: Hirzi Date: Thu, 12 Sep 2024 17:10:24 +0700 Subject: [PATCH] docs(config): update comments for better understanding --- config.yml | 102 +++++++++++++++++++++++++++-------------------------- 1 file changed, 52 insertions(+), 50 deletions(-) diff --git a/config.yml b/config.yml index 5364b8b..2eafae2 100644 --- a/config.yml +++ b/config.yml @@ -1,81 +1,83 @@ -# PteroStats config -# If you need help, join our discord server here: https://discord.gg/zv6maQRah3 -version: 5 # Do not change this unless you know what you are doing! +# PteroStats Configuration File +# Need help? Join our Discord server: https://discord.gg/zv6maQRah3 +version: 5 # Warning: Do not change this unless you know what you are doing! -# Bot Configuration +# Bot Presence Configuration presence: enable: true - text: "Hosting Panel" - type: "watching" # can be 'watching', 'playing', 'listening', or 'competing'. 'streaming' is not working for now - status: "online" # can be 'online', 'idle', 'dnd', or 'invisible' + text: "Hosting Panel" # The status text shown by the bot. + type: "watching" # Available types: 'watching', 'playing', 'listening', 'competing'. (Note: 'streaming' is currently unsupported) + status: "online" # Available types: 'online', 'idle', 'dnd', or 'invisible' -# Discord Channel and Refresh Time Configuration -refresh: 10 # How much time the bot will refresh the stats -timeout: 5 # How much time to wait for a node to respond to the bot (if you change this, it will add more time to refresh the stats) +# Discord Channel and Refresh Timing Configuration +refresh: 10 # Interval in seconds for refreshing the bot's stats. +timeout: 5 # Timeout in seconds for node responses. Adjusting this will affect the overall refresh time. # Message and Embed Configuration -# set the option as '' if you want to disable it +# To disable an option, leave the value as an empty string: '' message: - content: "" - attachment: "" # If you enable attachment on message it will upload the attachment first before sending or editing message and will result in delayed stats + content: "" # Custom content for bot messages. Set to '' to disable. + attachment: "" # Attachments will delay stats refresh since they are uploaded first. embed: panel: author: name: "Hosting Panel" - icon: "" - title: "Panel Stats" - description: "Next update {{time}}" - timestamp: false - color: "5865F2" + icon: "" # Icon URL for the author of the panel embed. + title: "Panel Stats" # Title of the panel stats embed. + description: "Next update {{time}}" # Description for the panel. {{time}} will display the next refresh time. + timestamp: false # Show the timestamp in the embed (true/false). + color: "5865F2" # Embed color in hex format. footer: - text: "" - icon: "" - thumbnail: "" - image: "" + text: "" # Footer text. Set to '' to disable. + icon: "" # Footer icon URL. + thumbnail: "" # Thumbnail URL for the embed. + image: "" # Image URL for the embed. + nodes: author: name: "Hosting Panel" - icon: "" - title: "Nodes Stats" - description: "" - timestamp: true - color: "5865F2" + icon: "" # Icon URL for the author of the nodes embed. + title: "Nodes Stats" # Title for the node stats embed. + description: "" # Description for the node stats embed. Can be left empty. + timestamp: true # Include a timestamp in the nodes embed (true/false). + color: "5865F2" # Embed color in hex format. footer: - text: "By @HirziDevs" - icon: "" - thumbnail: "" - image: "" + text: "By @HirziDevs" # Footer text for node stats. + icon: "" # Footer icon URL. + thumbnail: "" # Thumbnail URL for the node stats embed. + image: "" # Image URL for the node stats embed. # Message Button Configuration button: - enable: true + enable: true # Enable or disable buttons in messages. row1: - label: "Panel" - url: "https://panel.example.com" -# - label: "Dashboard" -# url: "https://dash.example.com" + url: "https://panel.example.com" # URL for the first button. +# - label: "Dashboard" # Uncomment to add a second button. +# url: "https://dash.example.com" # URL for the second button. # Status Message Configuration -# How to use custom emoji: https://github.com/HirziDevs/PteroStats#using-custom-emoji +# For details on using custom emojis, visit: https://github.com/HirziDevs/PteroStats#using-custom-emoji status: - online: ":green_circle: Online" - offline: ":red_circle: Offline" + online: ":green_circle: Online" # Status message for when a node is online. + offline: ":red_circle: Offline" # Status message for when a node is offline. -# Nodes Settings -# How to get nodes id: https://github.com/HirziDevs/PteroStats#blacklist-nodes +# Node Settings +# Instructions for retrieving node IDs: https://github.com/HirziDevs/PteroStats#blacklist-nodes nodes_settings: - blacklist: [] # You can add node id to remove the node from status embed (Example: "blacklist: [1]") - details: true # enable nodes details i.e memory and disk usage - servers: true - unit: "byte" # Allowed values: "byte" or "percentage" - limit: 100 + blacklist: [] # Add node IDs to exclude them from the status embed (e.g., blacklist: [1]). + details: true # Show node details such as memory and disk usage (true/false). + servers: true # Show server details (true/false). + unit: "byte" # Unit for node usage, Available types: "byte" or "percentage". + limit: 100 # Node limit for usage statistics display. # Panel Users and Servers Settings panel_settings: - status: true # enable panel stats under nodes stats - servers: true - users: true + status: true # Display panel stats under node stats (true/false). + servers: true # Display servers count (true/false). + users: true # Display users count (true/false). -# Log error to console if a server offline (enable this when you have a problem that you want to report) -log_error: false # set to "true" to enable \ No newline at end of file +# Error Logging Configuration +# Enable logging to console if servers go offline, useful for debugging. +log_error: false # Set to true to enable error logging.