@@ -3,20 +3,81 @@ Material Design theme for use with SimpleSAMLphp
33## Installation
44
55```
6- composer.phar require silinternational/simplesamlphp-module-theme- material:dev-master
6+ composer.phar require silinternational/simplesamlphp-module-material:dev-master
77```
88
99## Configuration
1010
1111Update ` /simplesamlphp/config/config.php ` :
1212
1313```
14- 'theme.use' => 'themematerial :material'
14+ 'theme.use' => 'material :material'
1515```
1616
17+ ### Google reCAPTCHA
18+ If a site key has been provided in ` $this->data['recaptcha.siteKey'] ` , the
19+ username/password page may require the user prove his/her humanity.
20+
21+ ### Branding
22+ Update ` /simplesamlphp/config/config.php ` :
23+
24+ ```
25+ 'theme.color-scheme' => ['indigo-purple'|'blue_grey-teal'|'red-teal'|'orange-light_blue']
26+ ```
27+
28+ ### Analytics
29+ Update ` /simplesamlphp/config/config.php ` :
30+
31+ ```
32+ 'analytics.trackingId' => 'UA-some-unique-id-for-your-site'
33+ ```
34+
35+ ### Announcements
36+ If something is found in ` $this->data['announcement'] ` an alert will be shown to the user filled with the
37+ content of that announcement. HTML is supported.
38+
1739## Testing theme
1840
19- 1 . Login to simplesaml's admin page, ` //yourhost/module.php/core/loginuserpass.php `
20- 2 . Click ** Authentication** tab
21- 3 . Click ** Test configured authentication sources**
22- 4 . Click ** auth-choices** (this list is built up from ` config/authsources.php ` )
41+ [ Make] ( https://www.gnu.org/software/make/ ) , [ Docker] ( https://www.docker.com/products/overview ) and
42+ [ Docker Compose] ( https://docs.docker.com/compose/install/ ) are required.
43+
44+ ### Setup
45+
46+ 1 . Setup ` localhost ` aliases for ` ssp-hub.local ` , ` ssp-hub-idp1.local ` , and ` ssp-hub-idp2.local ` . This is typically done in ` /etc/hosts ` .
47+ 2 . Start test environment, e.g., ` make ` from the command line.
48+ 3 . Goto [ http://ssp-hub.local ] ( http://ssp-hub.local ) .
49+ 4 . Login as hub administrator, e.g., username=admin & password=abc123
50+
51+ ### Hub
52+ 1 . Click ** Authentication** tab
53+ 2 . Click ** Test configured authentication sources**
54+ 3 . Click ** hub-discovery**
55+
56+ ### Error
57+ 1 . Click ** Configuration** tab
58+
59+ ### Logout
60+ 1 . Click ** Authentication** tab
61+ 2 . Click ** Test configured authentication sources**
62+ 3 . Click ** admin**
63+ 4 . Click ** Logout**
64+
65+ ### Login
66+ 1 . Click ** Authentication** tab
67+ 2 . Click ** Test configured authentication sources**
68+ 3 . Click ** hub-discovery**
69+ 4 . Click ** Login with idp1** (NOTE: login page should NOT have material design)
70+ 5 . Login as idp1 administrator, e.g., username=admin & password=a
71+ 6 . Click ** Logout**
72+ 7 . Click ** Authentication** tab
73+ 8 . Click ** Test configured authentication sources**
74+ 9 . Click ** hub-discovery**
75+ 10 . Click ** Login with idp2** (NOTE: login page should have material design)
76+ 11 . Login as idp2 administrator, e.g., username=admin & password=b
77+
78+ ## i18n support
79+ Translations are categorized by page in definition files located in the ` dictionaries ` directory.
80+
81+ Localization is affected by the configuration setting ` language.available ` . Only language codes found in this property will be utilized.
82+ For example, if a translation is provided in Afrikaans for this module, the configuration must be adjusted to make 'af' an available
83+ language. If that's not done, the translation function will not utilize the translations even if provided.
0 commit comments