Skip to content

Available sources and targets

Jump to bottom
Yvan edited this page Jan 13, 2026 · 6 revisions

🎭 Source Types

All sources can have the "cache-expiration" parameter, which adds a caching layer to that specific source. This value is in milliseconds and is not present by default. The option is useful when you have multiple sources with different restrictions. You can also use the "cache-failure" option to enable caching even on failure. It is important to note that even if you set the cache to 1 millisecond and cache-failure to false, the last value will be used in case of failure.

🏓PING

This type of source performs a MOTD ping request to a target server and retrieves the displayed number of online players. It is the easiest source to set up as it requires no prior installation.

    - type: "PING"
      # Hostname of the server to ping. (required)
      host: "localhost"
      # Port of the server to ping. (default: 25565)
      port: 25566
      # Timeout for the ping in milliseconds. (default: 5000)
      timeout: 5000
      # Protocol version number. 759 = 1.20.4. (default: 759)
      protocol: 759
      # Configure a proxy for the request. (optional)
      proxy:
        type: "SOCKS"
        host: "127.0.0.1"
        port: 1234

💾REDIS

This source type uses Redis to aggregate online players from multiple servers. This is the most recommended system for server networks. To work properly, broadcasting mode must be enabled on the servers hosting the players and use REDIS as the type.

    - type: "REDIS"
      # Redis key or channel that stores the count.
      set-key: "proxyonlinelinker:online"

📍SELF

This type of data source allows you to retrieve the number of connected users on the current instance. It is typically used in conjunction with other sources.

    - type: "SELF"

🔧FIXED

This source makes it possible to define a fixed, arbitrary value. In principle, this source should not be used, but it may be useful for debugging purposes or for stylistic reasons (e.g. 12345).

    - type: "FIXED"
      value: 20

📡 Target Types

💾REDIS

This target type uses Redis to store the number of connected players on the server.

    - type: "REDIS"
      # Redis key or channel that stores the count.
      set-key: "proxyonlinelinker:online"
      # Identifier for this server inside the network.
      server-id: "lobby1"
      # Key time-to-live in seconds; use 0/negative to disable expiry.
      # Expiration is important so that in case of a crash, the counter is reset.
      expire-seconds: 60

Clone this wiki locally