Merge pull request #29 from NetKnights-GmbH/28-update-the-code

Update the code

simplesamlphp-module-privacyidea/README.md

@@ -1,31 +1,24 @@
 # privacyIDEA simpleSAMLphp Plugin
 
-This plugin adds flexible, enterprise-grade two factor authentication 
+This plugin adds flexible, enterprise-grade two-factor authentication 
 to simplesSAMLphp. 
 
-It enables simpleSAMLphp to do two factor authentication against 
+It enables simpleSAMLphp to do two-factor authentication against 
 a [privacyIDEA server](https://github.com/privacyidea/privacyidea), 
 that runs in your network. Users can authenticate with normal OTP tokens, 
 Challenge Response tokens like EMail and SMS or using WebAuthn and U2F devices.
 TiQR is currently not supported.
 
-### Configuration
-Please check the [documentation](https://github.com/privacyidea/simplesamlphp-module-privacyidea/blob/master/docs/privacyidea.md)
-
-### Customization
-Please check the [readme](https://github.com/privacyidea/simplesamlphp-module-privacyidea/blob/master/themes/README.md)
-
-### Packagist and Composer
+## Installation
+It is recommended to install this package using [composer](https://getcomposer.org/). In your saml root dir, execute the following command in a terminal:
 
-The package is listed at packagist.
-https://packagist.org/packages/privacyidea/simplesamlphp-module-privacyidea
+`composer require privacyidea/simplesamlphp-module-privacyidea`
 
-simpleSAMLphp recommends to use composer to install plugins. For 
-more information about setting up composer see 
-https://getcomposer.org/doc/00-intro.md
-
-You can install this plugin into simpleSAMLphp like this:
+## Configuration
+Please check the [documentation](https://github.com/privacyidea/simplesamlphp-module-privacyidea/blob/master/docs/privacyidea.md)
 
-    composer require privacyidea/simplesamlphp-module-privacyidea
+## Customization (Themes)
+Please check the [documentation](https://github.com/privacyidea/simplesamlphp-module-privacyidea/blob/master/docs/pi-themes.md)
 
-Check for the latest version of the plugin.
+## Logfiles
+The saml log can be read with `journalctl -f`. If you encounter any problems that are not logged as errors, set the logging level of saml to debug by editing `{samlDir}/config/config.php`. Search for `logging.level` and set it so `SimpleSAML\Logger::DEBUG`. Alternatively, the apache error log can be checked for errors. It is located at `/var/log/apache2/error.log`

simplesamlphp-module-privacyidea/docs/pi-themes.md

@@ -0,0 +1,29 @@
+You can freely customize the module.
+
+You can adjust to your needs the one which is already available or build a new one.
+
+E.g. If you want to use dark theme in UCS, you may want to change the input's and button's font color.
+
+Change the font color in CSS with the following:
+
+      button, input { color: black !important; }
+
+
+To use the Google theme for login, you need to:
+
+1. Add 
+
+       "theme.use" => "privacyidea:google",
+
+   to your ``config.php`` file.
+
+
+2. Set up a directory ``/css`` in the webserver pointing to: ``/usr/share/simplesamlephp/modules/privacyidea/themes/google/css``. 
+
+
+On Apache you can paste the following to /etc/apache2/sites-available/foo-saml.conf:
+
+      Alias /css /usr/share/simplesamlphp/modules/privacyidea/themes/google/css
+      <Directory /usr/share/simplesamlphp/modules/privacyidea/themes/google/css>
+         Require all granted
+      </Directory>