From 318c057351666fa6559547c70717c1ec8381ac18 Mon Sep 17 00:00:00 2001 From: Thijs Kinkhorst <thijs@kinkhorst.com> Date: Mon, 4 Jul 2022 20:15:11 +0200 Subject: [PATCH] update links to external module docs --- docs/simplesamlphp-advancedfeatures.md | 10 +-------- docs/simplesamlphp-googleapps.md | 10 +-------- docs/simplesamlphp-idp-more.md | 2 +- docs/simplesamlphp-idp.md | 28 +++++++++----------------- docs/simplesamlphp-install.md | 2 +- docs/simplesamlphp-sp.md | 2 +- 6 files changed, 14 insertions(+), 40 deletions(-) diff --git a/docs/simplesamlphp-advancedfeatures.md b/docs/simplesamlphp-advancedfeatures.md index 73ef877e1..1373b279a 100644 --- a/docs/simplesamlphp-advancedfeatures.md +++ b/docs/simplesamlphp-advancedfeatures.md @@ -1,14 +1,6 @@ SimpleSAMLphp Advanced Features =============================== -<!-- - This file is written in Markdown syntax. - For more information about how to use the Markdown syntax, read here: - http://daringfireball.net/projects/markdown/syntax ---> - - - [TOC] SimpleSAMLphp documentation @@ -60,7 +52,7 @@ Automatic update of SAML 2.0 Metadata XML from HTTPS ---------------------------------------------------- The `metarefresh` module is the preferred method for doing this. -Please see the [metarefresh documentation](./metarefresh:simplesamlphp-automated_metadata). +Please see the [metarefresh documentation](/docs/contrib_modules/metarefresh/simplesamlphp-automated_metadata). diff --git a/docs/simplesamlphp-googleapps.md b/docs/simplesamlphp-googleapps.md index 1eedd439a..19b0532eb 100644 --- a/docs/simplesamlphp-googleapps.md +++ b/docs/simplesamlphp-googleapps.md @@ -1,14 +1,6 @@ Setting up a SimpleSAMLphp SAML 2.0 IdP to use with Google Workspace (G Suite / Google Apps) for Education ============================================ -<!-- - This file is written in Markdown syntax. - For more information about how to use the Markdown syntax, read here: - http://daringfireball.net/projects/markdown/syntax ---> - - - [TOC] SimpleSAMLphp news and documentation @@ -75,7 +67,7 @@ The next step is to configure the way users authenticate on your IdP. Various mo `exampleauth:Static` : Automatically log in as a user with a set of attributes. -[`ldap:LDAP`](./ldap:ldap) +[`ldap:LDAP`](/docs/contrib_modules/ldap/ldap.html) : Authenticates an user to a LDAP server. For more authentication modules, see [SimpleSAMLphp Identity Provider QuickStart](simplesamlphp-idp). diff --git a/docs/simplesamlphp-idp-more.md b/docs/simplesamlphp-idp-more.md index c2852a25d..eabaf95d5 100644 --- a/docs/simplesamlphp-idp-more.md +++ b/docs/simplesamlphp-idp-more.md @@ -14,7 +14,7 @@ If you have read about the AJAX iFrame Single Log-Out approach at Andreas' blog Attribute Release Consent ------------------------- -The attribute release consent is documented in a [separate document](./consent:consent). +The attribute release consent is documented in a [separate document](/docs/contrib_modules/consent/consent.html). Support for bookmarking the login page diff --git a/docs/simplesamlphp-idp.md b/docs/simplesamlphp-idp.md index b52ea0d5e..97cdb5318 100644 --- a/docs/simplesamlphp-idp.md +++ b/docs/simplesamlphp-idp.md @@ -1,13 +1,6 @@ SimpleSAMLphp Identity Provider QuickStart =========================================== -<!-- - This file is written in Markdown syntax. - For more information about how to use the Markdown syntax, read here: - http://daringfireball.net/projects/markdown/syntax ---> - - [TOC] This guide will describe how to configure SimpleSAMLphp as an identity provider (IdP). You should previously have installed SimpleSAMLphp as described in [the SimpleSAMLphp installation instructions](simplesamlphp-install) @@ -26,13 +19,13 @@ Authentication module The next step is to configure the way users authenticate on your IdP. Various modules in the `modules/` directory provides methods for authenticating your users. This is an overview of those that are included in the SimpleSAMLphp distribution: -[`authcrypt:Hash`](./authcrypt:authcrypt) +[`authcrypt:Hash`](/docs/contrib_modules/authcrypt/authcrypt.html) : Username & password authentication with hashed passwords. -[`authcrypt:Htpasswd`](./authcrypt:authcrypt) +[`authcrypt:Htpasswd`](/docs/contrib_modules/authcrypt/authcrypt.html) : Username & password authentication against .htpasswd file. -[`authX509:authX509userCert`](./authX509:authX509) +[`authX509:authX509userCert`](/docs/contrib_modules/authX509/authX509.html) : Authenticate against a LDAP database with a SSL client certificate. `exampleauth:UserPass` @@ -41,17 +34,17 @@ The next step is to configure the way users authenticate on your IdP. Various mo `exampleauth:Static` : Automatically log in as a user with a set of attributes. -[`ldap:LDAP`](./ldap:ldap) +[`ldap:LDAP`](/docs/contrib_modules/ldap/ldap.html) : Authenticates an user to a LDAP server. -[`ldap:LDAPMulti`](./ldap:ldap) +[`ldap:LDAPMulti`](/docs/contrib_modules/ldap/ldap.html) : Authenticates an user to one of several LDAP server. The user can choose the LDAP server from a dropdown list. -[`sqlauth:SQL`](./sqlauth:sql) +[`sqlauth:SQL`](/docs/contrib_modules/sqlauth/sql.html) : Authenticate an user against a database. -[`radius:Radius`](./radius:radius) +[`radius:Radius`](/docs/contrib_modules/radius/radius.html) : Authenticates an user to a Radius server. [`multiauth:MultiAuth`](./multiauth:multiauth) @@ -61,12 +54,9 @@ The next step is to configure the way users authenticate on your IdP. Various mo : Authenticate against a SAML IdP. Can be used for bridging. `authYubiKey:YubiKey` -: Authenticate with [an YubiKey](http://www.yubico.com/products/yubikey/). - -[`authfacebook:Facebook`](./authfacebook:authfacebook) -: Authenticate with a Facebook ID. +: Authenticate with [a YubiKey](https://www.yubico.com/products/yubikey/). -[`authtwitter:Twitter`](./authtwitter:oauthtwitter) +[`authtwitter:Twitter`](/docs/contrib_modules/authtwitter/oauthtwitter.html) : Authenticate with your Twitter account using the Twitter OAuth API. [`papi:PAPI`](https://github.com/rediris-es/simplesamlphp-module-papi/blob/master/README.md) diff --git a/docs/simplesamlphp-install.md b/docs/simplesamlphp-install.md index 6790267f4..560ddfade 100644 --- a/docs/simplesamlphp-install.md +++ b/docs/simplesamlphp-install.md @@ -375,7 +375,7 @@ in a separate document. + [Remote SP reference](simplesamlphp-reference-sp-remote) + [Setting up an IdP for Google Workspace (G Suite / Google Apps)](simplesamlphp-googleapps) + [Advanced Topics](simplesamlphp-idp-more) - - [Automated Metadata Management](./metarefresh:simplesamlphp-automated_metadata) + - [Automated Metadata Management](/docs/contrib_modules/metarefresh/simplesamlphp-automated_metadata) - [Maintenance and configuration](simplesamlphp-maintenance) diff --git a/docs/simplesamlphp-sp.md b/docs/simplesamlphp-sp.md index 5df29f4a3..345fa2078 100644 --- a/docs/simplesamlphp-sp.md +++ b/docs/simplesamlphp-sp.md @@ -158,7 +158,7 @@ in federations will differ, but the common part is that you would need to provide the *SAML 2.0 metadata of your SP*, and register that with the federation administration. You will probably be required too to consume the federation metadata periodically. Read more about -[automated metadata management](./metarefresh:simplesamlphp-automated_metadata) +[automated metadata management](/docs/contrib_modules/metarefresh/simplesamlphp-automated_metadata) to learn more about that. -- GitLab