peek.config.yaml.DOWNLOAD

# IF YOU WOULD LIKE TO CHANGE ANY CONFIGURATION, PLEASE STOP THE Peek APPLICATION, MAKE YOUR CHANGES TO THIS FILE, AND THEN START THE APPLICATION AGAIN.
# If this file is deleted, the application will create a new one with the default configuration values.
# The configuration file for peek. This file is in YAML format. See the README.md(https://github.com/fwuffyboi/peek) for more info.

auth:
  auth-required: false         # Should authentication be required to access the API? Default: false
  username: "peeky"            # The username to use for the API. Default: "peeky"
  password: "weeky"            # The password to use for the API. Default: "weeky"

logging:
  log-level: "INFO"            # The log level to use. See the README.md for more info. Default: "INFO"
  log-file: "peek.log"         # The log file name to use. See the README.md for more info. Default: peek.log

api:
  api-host: "0.0.0.0"          # The host to bind to. Default: 0.0.0.0
  api-port: 42649              # The port to bind to. Default: 42649

  rate-limit: 5                # How many requests can a user make PER SECOND to the API? Default: 5. 0 for no limit.

  shutdown-delay: 1            # How many minutes to wait before shutting down the server? Default: 1

  # The trusted proxies to use. Trusted proxies are IP addresses on the Public WAN or private LAN that are officially
  # trusted by Peek to be able to forward and serve this page on behalf of this server. Use this if you are reverse-proxying
  # as the server will trust the IP address of the proxy hence client information will actually be correct. This is a ]
  # security feature more than anything else. If you are not reverse-proxying, you can leave this as is.
  # Default: ["127.0.0.1", "localhost"]
  trusted-proxies:
    - "127.0.0.1"
    # - "192.168.0.1"  # example 1
    # - "192.168.0.47" # example 2

  swagger-enabled: true        # Should the swagger UI be enabled? Default: true

actions:
  shutdown-system: false       # Should a user be able to shut down the server?
  shutdown-peek: false         # Should a user be able to shut down peek?

show:
  show-hostname: true          # Should the hostname be shown?
  show-ip: false               # Should the server's IP be shown?
  show-server-country: true    # Should the server country be shown?
  show-client-country: true    # Should the client country be shown?
  show-uptime: true            # Should the uptime be shown?
  show-ram: true               # Should the ram usage be shown?
  show-cpu: true               # Should cpu related information be shown?
  show-cpu-use: true           # Should the cpu usage be shown?
  show-disk: true              # Should disk related information be shown?
  show-cpu-temp: true          # Should the temperature be shown?
  show-logs-api: true          # Should the logs be shown on the API?
  show-timezone: true          # Should the server's timezone AND time be shown?

disk:
  exclude-disks: false  # would you like to exclude disks from being shown? Default: false
  excluded-disks:
    - "/boot"     # example 1
    - "/boot/efi" # example 2


integrations:
  telegram:
    telegram-enabled:   false              # Should the telegram integration be enabled?
    telegram-bot-token: "YOUR_TOKEN"       # The bot token for the telegram bot.
    telegram-chat-id:   "YOUR_CHAT_ID"     # The chat id for the telegram bot.
    telegram-message:   "Alert from Peek!: %alert%"  # The message to send to the telegram bot. %alert% will be replaced with the alert message.