documentation:2.1:checkstate

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

documentation:2.1:checkstate [2019/10/28 15:24]
documentation:2.1:checkstate [2019/10/28 15:37] (current)
Line 1: Line 1:
 +====== Check state plugin ======
  
 +This plugin can be used to check if portal instance is ready. This can be a health check to request keep-alive service to force a fail-over on the backup-node.
 +
 +===== Configuration =====
 +
 +Just enable it in the manager (*//General Parameters// » //Plugins// » //State Check//). You __must__ also set a shared secret.
 +
 +===== Usage =====
 +
 +When enabled, ''/checkstate'' URL path is handled by this plugin. GET parameters:
 +
 +^  GET Parameter  ^  Need  ^  Value  ^
 +|  ''secret''  |  required  | Same value as the shared secret given to the manager |
 +|  ''user''  |  optional  | If set (with password), a login/logout process will be tried |
 +|  ''password''  |  optional  |  :::  |
 +
 +==== Example ====
 +
 +  * Basic availability check: ''https://auth.example.com/checkstate?secret=qwerty''
 +  * Try to log a user in: ''https://auth.example.com/checkstate?secret=qwerty&user=dwho&password=dwho''