]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/openid.mdwn
Change Projects link to point to projects DB
[ikiwiki.git] / doc / plugins / openid.mdwn
index 3fb4c26b82983d2e99bcff24f6ef6677327f6a01..82c23fc4f6a0d6d3d4a4a8eab848c9d4f755463c 100644 (file)
@@ -17,15 +17,21 @@ only use some other form of authentication, such as [[passwordauth]].
 ## options
 
 These options do not normally need to be set, but can be useful in
-certian setups.
+certain setups.
 
 * `openid_realm` can be used to control the scope of the openid request.
   It defaults to the `cgiurl` (or `openid_cgiurl` if set); only allowing
   ikiwiki's [[CGI]] to authenticate. If you have multiple ikiwiki instances,
   or other things using openid on the same site, you may choose to put them
-  all in the same realm to improve the user's openid experience.
+  all in the same realm to improve the user's openid experience. It is an
+  url pattern, so can be set to eg "http://*.example.com/"
 
 * `openid_cgiurl` can be used to cause a different than usual `cgiurl`
   to be used when doing openid authentication. The `openid_cgiurl` must
   point to an ikiwiki [[CGI]], and it will need to match the `openid_realm`
   to work.
+
+## troubleshooting
+
+See [[plugins/openid/troubleshooting]] for a number of issues that may
+need to be addressed when setting up ikiwiki to accept OpenID logins reliably.