Skip to content

Commit da470b7

Browse files
committed
Update documentation
1 parent f9c52dc commit da470b7

5 files changed

Lines changed: 21 additions & 21 deletions

File tree

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ SimpleSAMLphp Documentation
3131
* [Configuring HTTP-Artifact](./simplesamlphp-artifact-idp)
3232
* [Identity Provider Advanced Topics](simplesamlphp-idp-more)
3333
* [Holder-of-Key profile](simplesamlphp-hok-idp)
34-
* [Automated Metadata Management](https://github.com/simplesamlphp/simplesamlphp-module-metarefresh/blob/master/docs/simplesamlphp-automated_metadata.md)
34+
* [Automated Metadata Management](metarefresh:simplesamlphp-automated_metadata)
3535
* [Maintenance and configuration](simplesamlphp-maintenance) - covers session handling, php configuration etc.
3636
* [Authentication Processing Filters](simplesamlphp-authproc) - attribute filtering, attribute mapping, consent, group generation etc.
3737
* [Advanced features](simplesamlphp-advancedfeatures) - covers bridging protocols, attribute filtering, etc.
@@ -49,7 +49,7 @@ Documentation on specific SimpleSAMLphp modules:
4949
* [Consent module](./consent:consent)
5050
* [Installing and configuring the consentAdmin module](./consentAdmin:consentAdmin)
5151
* [Authorization](./authorize:authorize)
52-
* [autotest Module](./autotest:test)
52+
* [autotest Module](https://github.com/simplesamlphp/simplesamlphp-module-autotest/blob/v1.0/README.md)
5353
* [Statistics](./statistics:statistics)
5454

5555
Documentation for SimpleSAMLphp developers:

docs/simplesamlphp-advancedfeatures.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Automatic update of SAML 2.0 Metadata XML from HTTPS
6060
----------------------------------------------------
6161

6262
The `metarefresh` module is the preferred method for doing this.
63-
Please see the [metarefresh documentation](https://github.com/simplesamlphp/simplesamlphp-module-metarefresh/blob/master/docs/simplesamlphp-automated_metadata.md).
63+
Please see the [metarefresh documentation](metarefresh:simplesamlphp-automated_metadata).
6464

6565

6666

docs/simplesamlphp-customauth.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
Implementing custom username/password authentication
22
====================================================
33

4-
This is a step-by-step guide for creating a custom username/password [authentication source](./simplesamlphp-authsource.md) for SimpleSAMLphp.
4+
This is a step-by-step guide for creating a custom username/password [authentication source](./simplesamlphp-authsource) for SimpleSAMLphp.
55
An authentication source is responsible for authenticating the user, typically by getting a username and password, and looking it up in some sort of database.
66

77
<!-- {{TOC}} -->
88

99
Create a custom module
1010
----------------------
1111

12-
All custom code for SimpleSAMLphp should be contained in a [module](./simplesamlphp-modules.md).
12+
All custom code for SimpleSAMLphp should be contained in a [module](./simplesamlphp-modules).
1313
This ensures that you can upgrade your SimpleSAMLphp installation without overwriting your own code.
1414
In this example, we will call the module `mymodule`.
1515
It will be located under `modules/mymodule`.
@@ -216,7 +216,7 @@ Note that we have updated the username & password to "theconfigusername" and "th
216216
A more complete example - custom database authentication
217217
--------------------------------------------------------
218218

219-
The [sqlauth:SQL](../modules/sqlauth/docs/sql.md) authentication source can do simple authentication against SQL databases.
219+
The [sqlauth:SQL](sqlauth:sql) authentication source can do simple authentication against SQL databases.
220220
However, in some cases it cannot be used, for example because the database layout is too complex, or because the password validation routines cannot be implemented in SQL.
221221
What follows is an example of an authentication source that fetches an user from a database, and validates the password using a custom function.
222222

docs/simplesamlphp-install.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This document is part of the SimpleSAMLphp documentation suite.
2020

2121
This document covers the installation of the latest stable version of SimpleSAMLphp.
2222
If you want to install the development version, take a look at the instructions for [installing SimpleSAMLphp from the
23-
repository](simplesamlphp-install-repo.md).
23+
repository](simplesamlphp-install-repo).
2424

2525

2626
Prerequisites
@@ -153,7 +153,7 @@ Note the `Alias` directive, which gives control to SimpleSAMLphp for all urls ma
153153
them are accessible through the `www` subdirectory of your SimpleSAMLphp installation. You can name the alias
154154
whatever you want, but the name must be specified in the `baseurlpath` configuration option in the `config.php` file of
155155
SimpleSAMLphp as described in
156-
[the section called “SimpleSAMLphp configuration: config.php”](#sect.config "SimpleSAMLphp configuration: config.php").
156+
[the section called “SimpleSAMLphp configuration: config.php”](#section_6 "SimpleSAMLphp configuration: config.php").
157157
Here is an example of how this configuration may look like in `config.php`:
158158

159159
```
@@ -174,7 +174,7 @@ directory too, use the `metadatadir` configuration option to specify the locatio
174174

175175
This is just the basic configuration to get things working. For a checklist
176176
further completing your documentation, please see
177-
[Maintenance and configuration: Apache](simplesamlphp-maintenance.md#apache-configuration).
177+
[Maintenance and configuration: Apache](simplesamlphp-maintenance#section_5).
178178

179179

180180
Configuring Nginx
@@ -234,7 +234,7 @@ There are a few steps that you should complete in the main configuration file, `
234234
- Set an administrator password. This is needed to access some of the pages in your SimpleSAMLphp installation web
235235
interface.
236236

237-
Hashed passwords can also be used here. See the [`authcrypt`](../modules/authcrypt/docs/authcrypt.md) documentation
237+
Hashed passwords can also be used here. See the [`authcrypt`](authcrypt:authcrypt) documentation
238238
for more information.
239239

240240
```
@@ -366,16 +366,16 @@ Provider (in order to protect access to an existing application) or an Identity
366366
a user database where your users can authenticate). Documentation on bridging between federation protocols is found
367367
in a separate document.
368368

369-
- [Using SimpleSAMLphp as a Service Provider (SP)](simplesamlphp-sp.md)
370-
+ [Remote IdP reference](simplesamlphp-reference-idp-remote.md)
369+
- [Using SimpleSAMLphp as a Service Provider (SP)](simplesamlphp-sp)
370+
+ [Remote IdP reference](simplesamlphp-reference-idp-remote)
371371
+ [Connecting to the UK Access Federation or InCommon](simplesamlphp-ukaccess)
372-
- [Using SimpleSAMLphp as an Identity Provider (IdP)](simplesamlphp-idp.md)
373-
+ [Hosted IdP reference](simplesamlphp-reference-idp-hosted.md)
374-
+ [Remote SP reference](simplesamlphp-reference-sp-remote.md)
375-
+ [Setting up an IdP for G Suite (Google Apps)](simplesamlphp-googleapps.md)
376-
+ [Advanced Topics](simplesamlphp-idp-more.md)
377-
- [Automated Metadata Management](https://github.com/simplesamlphp/simplesamlphp-module-metarefresh/blob/master/docs/simplesamlphp-automated_metadata.md)
378-
- [Maintenance and configuration](simplesamlphp-maintenance.md)
372+
- [Using SimpleSAMLphp as an Identity Provider (IdP)](simplesamlphp-idp)
373+
+ [Hosted IdP reference](simplesamlphp-reference-idp-hosted)
374+
+ [Remote SP reference](simplesamlphp-reference-sp-remote)
375+
+ [Setting up an IdP for G Suite (Google Apps)](simplesamlphp-googleapps)
376+
+ [Advanced Topics](simplesamlphp-idp-more)
377+
- [Automated Metadata Management](metarefresh:simplesamlphp-automated_metadata)
378+
- [Maintenance and configuration](simplesamlphp-maintenance)
379379

380380

381381
Support
@@ -406,7 +406,7 @@ The SimpleSAMLphp package contains one folder named `simplesamlphp-x.y.z` (where
406406
this folder there are a lot of subfolders for library, metadata, configuration, etc. One of these folders is named
407407
`www`. **Only this folder should be exposed on the web**. The recommended configuration is to put the whole
408408
`simplesamlphp` folder outside the web root, and then link to the `www` folder by using the `Alias` directive, as
409-
described in [the section called “Configuring Apache”](#sect.apacheconfig "Configuring Apache"). This is not the only
409+
described in [the section called “Configuring Apache”](#section_4 "Configuring Apache"). This is not the only
410410
possible way, though.
411411

412412
As an example, let's see how you can install SimpleSAMLphp in your home directory on a shared hosting server.

docs/simplesamlphp-sp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ directory.
122122
If you intend to add your SP to a federation, the procedure for managing trust in federations differ, but the common part is
123123
that you would need to provide the *SAML 2.0 metadata of your SP*, and register that with the federation administration.
124124
You will probably be required too to consume the federation metadata periodically. Read more about
125-
[automated metadata management](https://github.com/simplesamlphp/simplesamlphp-module-metarefresh/blob/master/docs/simplesamlphp-automated_metadata.md) to learn more about that.
125+
[automated metadata management](metarefresh:simplesamlphp-automated_metadata) to learn more about that.
126126

127127

128128
Test the SP

0 commit comments

Comments
 (0)