Skip to content
Snippets Groups Projects
Commit e117f548 authored by Joel Franusic's avatar Joel Franusic
Browse files

Minor documentation corrections

parent 7c02bdba
No related branches found
No related tags found
No related merge requests found
...@@ -17,7 +17,7 @@ simpleSAMLphp news and documentation ...@@ -17,7 +17,7 @@ simpleSAMLphp news and documentation
This document is part of the simpleSAMLphp documentation suite. This document is part of the simpleSAMLphp documentation suite.
* [List of all simpleSAMLphp documentation](http://simplesamlphp.org/docs) * [List of all simpleSAMLphp documentation](http://simplesamlphp.org/docs)
* [Latest news about simpleSAMLphp](http://rnd.feide.no/taxonomy/term/4). (Also conatins an RSS feed) * [Latest news about simpleSAMLphp](http://rnd.feide.no/taxonomy/term/4). (Also contains an RSS feed)
* [simpleSAMLphp homepage](https://simplesamlphp.org) * [simpleSAMLphp homepage](https://simplesamlphp.org)
...@@ -48,7 +48,7 @@ What actual packages are required for the various extensions varies between diff ...@@ -48,7 +48,7 @@ What actual packages are required for the various extensions varies between diff
Download and install simpleSAMLphp Download and install simpleSAMLphp
---------------------------------- ----------------------------------
The most recent relase of simpleSAMLphp is found at [https://simplesamlphp.org/download](https://simplesamlphp.org/download). The most recent release of simpleSAMLphp is found at [https://simplesamlphp.org/download](https://simplesamlphp.org/download).
Go to the directory where you want to install simpleSAMLphp, and extract the archive file you just downloaded: Go to the directory where you want to install simpleSAMLphp, and extract the archive file you just downloaded:
...@@ -143,9 +143,9 @@ file, `config.php`, right away: ...@@ -143,9 +143,9 @@ file, `config.php`, right away:
'technicalcontact_email' => 'andreas.solberg@uninett.no', 'technicalcontact_email' => 'andreas.solberg@uninett.no',
- -
If you use simpleSAMLphp in a country where english is not If you use simpleSAMLphp in a country where English is not
widespread, you may want to change the default language from widespread, you may want to change the default language from
english to something else: English to something else:
'language.default' => 'no', 'language.default' => 'no',
...@@ -191,7 +191,7 @@ After installing simpleSAMLphp, you can access the homepage of your installation ...@@ -191,7 +191,7 @@ After installing simpleSAMLphp, you can access the homepage of your installation
https://service.example.org/simplesaml/ https://service.example.org/simplesaml/
The exact link depends on how you set it up with Apache, and off course on your hostname. The exact link depends on how you set it up with Apache, and of course on your hostname.
### Warning ### Warning
...@@ -248,10 +248,10 @@ in an alternative way. ...@@ -248,10 +248,10 @@ in an alternative way.
Still you can install simpleSAMLphp - keep on reading. Still you can install simpleSAMLphp - keep on reading.
2. You have full permissions to the server, but cannot edit Apache 2. You have full permissions to the server, but cannot edit Apache
configuration for some reason, polictics, policy or whatever. configuration for some reason, politics, policy or whatever.
The SimpleSAMLphp code contains one folder named `simplesamlphp`. In this folder there are a lot of subfolders for library, metadata, configuration and much more. One of these folders is named `www`. This and *only this* folder should be exposed on the web. The reccomended configuration is to put the whole `simplesamlphp` folder outside the webroot, and then link in the `www` folder by using the `Alias` directive, as described in [the section called “Configuring Apache”](#sect.apacheconfig "Configuring Apache"). But this is not the only possible way. The SimpleSAMLphp code contains one folder named `simplesamlphp`. In this folder there are a lot of subfolders for library, metadata, configuration and much more. One of these folders is named `www`. This and *only this* folder should be exposed on the web. The recommended configuration is to put the whole `simplesamlphp` folder outside the webroot, and then link in the `www` folder by using the `Alias` directive, as described in [the section called “Configuring Apache”](#sect.apacheconfig "Configuring Apache"). But this is not the only possible way.
As an example, let's see how you can install simpleSAMLphp in your home directory on a shared hosting server. As an example, let's see how you can install simpleSAMLphp in your home directory on a shared hosting server.
......
...@@ -114,13 +114,13 @@ The script requires that the config file `translation.php` is copied from `confi ...@@ -114,13 +114,13 @@ The script requires that the config file `translation.php` is copied from `confi
The script may be used to these tasks: The script may be used to these tasks:
* upload definition files * Uploading definition files
* download defintion files * Downloading definition files
* download translation files * Downloading translation files
### Uploading defintion files ### Uploading defintion files
You probably do not have access to upload definition files for the simpleSAMLphp application. But, from January 2010, the translation portal is generic to host multiple independent applications. What you may do is to contact Andreas to add your own application to the translation portal, where you off course have access to upload definition files. You probably do not have access to upload definition files for the simpleSAMLphp application. But, from January 2010, the translation portal is generic to host multiple independent applications. What you may do is to contact Andreas to add your own application to the translation portal, where you of course have access to upload definition files.
**Note**: an application may very well be a local simpleSAMLphp module that you run. **Note**: an application may very well be a local simpleSAMLphp module that you run.
...@@ -152,7 +152,7 @@ The script uses OAuth to connect your session on the command line client with th ...@@ -152,7 +152,7 @@ The script uses OAuth to connect your session on the command line client with th
### Deleting defintion files ### Deleting definition files
Is perfomed via the webbased translation portal. Is perfomed via the webbased translation portal.
...@@ -162,7 +162,7 @@ Seldom used, as the defintion file is manually created locally. Anyway: ...@@ -162,7 +162,7 @@ Seldom used, as the defintion file is manually created locally. Anyway:
bin/translation.php pulldef modules/MODULENAME/dictionaries/BASENAME.definition.json bin/translation.php pulldef modules/MODULENAME/dictionaries/BASENAME.definition.json
Ooutput example: Output example:
Action: [pulldef] Action: [pulldef]
Application: [simplesamlphp] Application: [simplesamlphp]
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment