2018-05-15 21:50:12 +02:00
<!DOCTYPE html>
< html lang = "en" dir = "ltr" >
< head >
< meta charset = "utf-8" / >
< title > documentation:2.0:checkstate< / title >
< meta name = "generator" content = "DokuWiki" / >
2018-06-07 13:48:21 +02:00
< meta name = "robots" content = "index,follow" / >
2018-05-15 21:50:12 +02:00
< meta name = "keywords" content = "documentation,2.0,checkstate" / >
< link rel = "search" type = "application/opensearchdescription+xml" href = "lib/exe/opensearch.html" title = "LemonLDAP::NG" / >
< link rel = "start" href = "checkstate.html" / >
< link rel = "contents" href = "checkstate.html" title = "Sitemap" / >
< link rel = "stylesheet" type = "text/css" href = "lib/exe/css.php.t.bootstrap3.css" / >
<!-- //if:usedebianlibs
< link rel = "stylesheet" type = "text/css" href = "/javascript/bootstrap/css/bootstrap.min.css" / >
//elsif:useexternallibs
< link rel = "stylesheet" type = "text/css" href = "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" > < / script >
//elsif:cssminified
< link rel = "stylesheet" type = "text/css" href = "/static/bwr/bootstrap/dist/css/bootstrap.min.css" / >
//else -->
< link rel = "stylesheet" type = "text/css" href = "/static/bwr/bootstrap/dist/css/bootstrap.css" / >
<!-- //endif -->
< script type = "text/javascript" > / * < ! [ C D A T A [ * / v a r N S = ' d o c u m e n t a t i o n : 2 . 0 ' ; v a r J S I N F O = { " i d " : " d o c u m e n t a t i o n : 2 . 0 : c h e c k s t a t e " , " n a m e s p a c e " : " d o c u m e n t a t i o n : 2 . 0 " } ;
/*!]]>*/< / script >
< script type = "text/javascript" charset = "utf-8" src = "lib/exe/js.php.t.bootstrap3.js" > < / script >
<!-- //if:usedebianlibs
< script type = "text/javascript" src = "/javascript/jquery/jquery.min.js" > < / script >
//elsif:useexternallibs
< script type = "text/javascript" src = "http://code.jquery.com/jquery-2.2.0.min.js" > < / script >
//elsif:jsminified
< script type = "text/javascript" src = "/static/bwr/jquery/dist/jquery.min.js" > < / script >
//else -->
< script type = "text/javascript" src = "/static/bwr/jquery/dist/jquery.js" > < / script >
<!-- //endif -->
<!-- //if:usedebianlibs
< script type = "text/javascript" src = "/javascript/jquery-ui/jquery-ui.min.js" > < / script >
//elsif:useexternallibs
< script type = "text/javascript" src = "http://code.jquery.com/ui/1.10.4/jquery-ui.min.js" > < / script >
//elsif:jsminified
< script type = "text/javascript" src = "/static/bwr/jquery-ui/jquery-ui.min.js" > < / script >
//else -->
< script type = "text/javascript" src = "/static/bwr/jquery-ui/jquery-ui.js" > < / script >
<!-- //endif -->
< / head >
< body >
< div class = "dokuwiki export container" >
< h1 class = "sectionedit1" id = "check_state_plugin" > Check state plugin< / h1 >
< div class = "level1" >
< p >
2018-07-14 22:23:25 +02:00
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.
2018-05-15 21:50:12 +02:00
< / p >
< / div >
2018-07-14 22:23:25 +02:00
<!-- EDIT1 SECTION "Check state plugin" [1 - 195] -->
2018-05-15 21:50:12 +02:00
< h2 class = "sectionedit2" id = "configuration" > Configuration< / h2 >
< div class = "level2" >
< p >
Just enable it in the manager (section “plugins”). You < em class = "u" > must< / em > also set a shared secret.
< / p >
< / div >
2018-07-14 22:23:25 +02:00
<!-- EDIT2 SECTION "Configuration" [196 - 313] -->
2018-05-15 21:50:12 +02:00
< h2 class = "sectionedit3" id = "usage" > Usage< / h2 >
< div class = "level2" >
< p >
2018-05-17 21:42:46 +02:00
When enabled, < code > /checkstate< / code > < abbr title = "Uniform Resource Locator" > URL< / abbr > path is handled by this plugin. GET parameters:
2018-05-15 21:50:12 +02:00
< / p >
< div class = "table sectionedit4" > < table class = "inline table table-bordered table-striped" >
< thead >
< tr class = "row0 roweven" >
2018-05-17 21:42:46 +02:00
< th class = "col0 centeralign" > GET Parameter < / th > < th class = "col1 centeralign" > Need < / th > < th class = "col2 centeralign" > Value < / th >
2018-05-15 21:50:12 +02:00
< / tr >
< / thead >
< tr class = "row1 rowodd" >
2018-05-17 21:42:46 +02:00
< td class = "col0 centeralign" > < code > secret< / code > < / td > < td class = "col1 centeralign" > required < / td > < td class = "col2" > Same value as the shared secret given to the manager < / td >
2018-05-15 21:50:12 +02:00
< / tr >
< tr class = "row2 roweven" >
2018-05-17 21:42:46 +02:00
< td class = "col0 centeralign" > < code > user< / code > < / td > < td class = "col1 centeralign" > optional < / td > < td class = "col2" rowspan = "2" > If set (with password), a login/logout process will be tried < / td >
2018-05-15 21:50:12 +02:00
< / tr >
< tr class = "row3 rowodd" >
2018-05-17 21:42:46 +02:00
< td class = "col0 centeralign" > < code > password< / code > < / td > < td class = "col1 centeralign" > optional < / td >
2018-05-15 21:50:12 +02:00
< / tr >
< / table > < / div >
2018-07-14 22:23:25 +02:00
<!-- EDIT4 TABLE [416 - 670] -->
2018-05-15 21:50:12 +02:00
< p >
Example: < code > < a href = "https://auth.example.com/checkstate?secret=qwerty&user=dwho&password=dwho" class = "urlextern" title = "https://auth.example.com/checkstate?secret=qwerty&user=dwho&password=dwho" rel = "nofollow" > https://auth.example.com/checkstate?secret=qwerty& user=dwho& password=dwho< / a > < / code >
< / p >
< / div >
2018-07-14 22:23:25 +02:00
<!-- EDIT3 SECTION "Usage" [314 - ] --> < / div >
2018-05-15 21:50:12 +02:00
< / body >
< / html >