Skip to content
This repository was archived by the owner on Jun 25, 2024. It is now read-only.

Commit 2f31511

Browse files
author
Billy Clark
committed
updates were missed form previous commits
1 parent 05387cb commit 2f31511

File tree

1 file changed

+83
-58
lines changed

1 file changed

+83
-58
lines changed

‎README.md‎

Lines changed: 83 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Update `/simplesamlphp/config/config.php`:
1414
'theme.use' => 'material:material'
1515
```
1616

17+
_[ssp-base](https://github.com/silinternational/ssp-base) provides a convenience by loading this config with whatever is in the environment variable `THEME_USE`._
18+
1719
### Google reCAPTCHA
1820
If a site key has been provided in `$this->data['recaptcha.siteKey']`, the
1921
username/password page may require the user prove his/her humanity.
@@ -25,8 +27,7 @@ Update `/simplesamlphp/config/config.php`:
2527
'theme.color-scheme' => ['indigo-purple'|'blue_grey-teal'|'red-teal'|'orange-light_blue']
2628
```
2729

28-
The login page will get its images from `/simplesamlphp/www/favicon.ico` and
29-
`/simplesamlphp/www/logo.png` which are **NOT** provided by default.
30+
The login page looks for `/simplesamlphp/www/logo.png` which is **NOT** provided by default.
3031

3132
### Analytics
3233
Update `/simplesamlphp/config/config.php`:
@@ -35,9 +36,18 @@ Update `/simplesamlphp/config/config.php`:
3536
'analytics.trackingId' => 'UA-some-unique-id-for-your-site'
3637
```
3738

39+
_[ssp-base](https://github.com/silinternational/ssp-base) provides a convenience by loading this config with whatever is in the environment variable `ANALYTICS_ID`._
40+
3841
### Announcements
39-
If something is found in `$this->data['announcement']` an alert will be shown to the user filled with the
40-
content of that announcement. HTML is supported.
42+
Update `/simplesamlphp/config/config.php`:
43+
44+
```
45+
'announcement' => 'Some <strong>important</strong> announcement'
46+
```
47+
48+
_[ssp-base](https://github.com/silinternational/ssp-base) provides a convenience by loading this config with whatever is in `/simplesamlphp/announcement/announcement.php`._
49+
50+
If configured, an alert will be shown to the user filled with the content of that announcement. HTML is supported.
4151

4252
## Testing theme
4353

@@ -46,42 +56,78 @@ content of that announcement. HTML is supported.
4656

4757
### Setup
4858

49-
1. Setup `localhost` aliases for `ssp-hub.local`, `ssp-hub-idp1.local`, and `ssp-hub-idp2.local`. This is typically done in `/etc/hosts`.
59+
1. Setup `localhost` aliases for `ssp-hub.local`, `ssp-hub2.local`, `ssp-hub-idp1.local`, and `ssp-hub-idp2.local`. This is typically done in `/etc/hosts`.
5060
2. Start test environment, e.g., `make` from the command line.
51-
3. Goto [http://ssp-hub.local](http://ssp-hub.local).
52-
4. Login as hub administrator, e.g., username=admin & password=abc123
53-
54-
### Hub
55-
1. Click **Authentication** tab
56-
2. Click **Test configured authentication sources**
57-
3. Click **hub-discovery**
58-
59-
### Error
60-
1. Click **Federation** tab
61-
2. Click either **Show metadata** link
62-
63-
### Logout
64-
1. Click **Authentication** tab
65-
2. Click **Test configured authentication sources**
66-
3. Click **admin**
67-
4. Click **Logout**
68-
69-
### Login
70-
1. Click **Authentication** tab
71-
2. Click **Test configured authentication sources**
72-
3. Click **hub-discovery**
73-
4. Click **Login with idp1** (NOTE: login page should NOT have material design)
74-
5. Login as idp1 administrator, e.g., username=admin & password=a
61+
62+
### Hub page
63+
1. Goto [http://ssp-hub.local](http://ssp-hub.local)
64+
2. Login as hub administrator, e.g., username=admin & password=abc123
65+
3. Click **Authentication** tab
66+
4. Click **Test configured authentication sources**
67+
5. Click **hub-discovery**
68+
69+
### Error page
70+
1. Goto [http://ssp-hub.local](http://ssp-hub.local)
71+
2. Login as hub administrator, e.g., username=admin & password=abc123
72+
3. Click **Federation** tab
73+
4. Click either **Show metadata** link
74+
75+
### Logout page
76+
1. Goto [http://ssp-hub.local](http://ssp-hub.local)
77+
2. Login as hub administrator, e.g., username=admin & password=abc123
78+
3. Click **Authentication** tab
79+
4. Click **Test configured authentication sources**
80+
5. Click **admin**
7581
6. Click **Logout**
76-
7. Goto [http://ssp-hub.local](http://ssp-hub.local)
77-
8. Click **Authentication** tab
78-
9. Click **Test configured authentication sources**
79-
10. Click **hub-discovery**
80-
11. Click **Login with idp2** (NOTE: login page should have material design)
81-
12. Login as an idp2 user, e.g., username=distant_future & password=a
82-
13. Click **Logout**
8382

84-
### Announcements
83+
### Login page
84+
1. Goto [http://ssp-hub.local](http://ssp-hub.local)
85+
2. Login as hub administrator, e.g., username=admin & password=abc123
86+
3. Click **Authentication** tab
87+
4. Click **Test configured authentication sources**
88+
5. Click **hub-discovery**
89+
6. Click **Login with idp1** (NOTE: login page should NOT have material design)
90+
7. Login as idp1 administrator, e.g., username=admin & password=a
91+
8. Click **Logout**
92+
9. Goto [http://ssp-hub.local](http://ssp-hub.local)
93+
10. Click **Authentication** tab
94+
11. Click **Test configured authentication sources**
95+
12. Click **hub-discovery**
96+
13. Click **Login with idp2** (NOTE: login page should have material design)
97+
14. Login as an idp2 user, e.g., username=distant_future & password=a
98+
15. Click **Logout**
99+
100+
### Forgot password functionality
101+
1. Goto [http://ssp-hub.local](http://ssp-hub.local)
102+
2. Login as hub administrator, e.g., username=admin & password=abc123
103+
3. Click **Authentication** tab
104+
4. Click **Test configured authentication sources**
105+
5. Click **hub-discovery**
106+
6. Click **Login with idp2**
107+
7. Forgot password link should be visible
108+
109+
### Expiry functionality
110+
#### About to expire page
111+
1. Goto [http://ssp-hub.local](http://ssp-hub.local)
112+
2. Login as hub administrator, e.g., username=admin & password=abc123
113+
3. Click **Authentication** tab
114+
4. Click **Test configured authentication sources**
115+
5. Click **hub-discovery**
116+
6. Click **Login with idp2**
117+
7. Login as an an "about to expire" user, e.g., username=near_future & password=b
118+
8. Click **Later**
119+
9. Click **Logout**
120+
121+
#### Expired page
122+
1. Goto [http://ssp-hub.local](http://ssp-hub.local)
123+
2. Login as hub administrator, e.g., username=admin & password=abc123
124+
3. Click **Authentication** tab
125+
4. Click **Test configured authentication sources**
126+
5. Click **hub-discovery**
127+
6. Click **Login with idp2**
128+
7. Login as an an "expired" user, e.g., username=already_past & password=c
129+
130+
### Announcements functionality
85131
1. Goto [http://ssp-hub2.local:8081](http://ssp-hub2.local:8081)
86132
2. The announcement should be displayed
87133
3. Login as hub2 administrator, e.g., username=admin & password=abc123
@@ -92,27 +138,6 @@ content of that announcement. HTML is supported.
92138
8. Click **Login with idp3**
93139
9. The announcement should be displayed
94140

95-
### Expiry
96-
97-
#### About to expire
98-
1. Goto [http://ssp-hub.local](http://ssp-hub.local)
99-
2. Click **Authentication** tab
100-
3. Click **Test configured authentication sources**
101-
4. Click **hub-discovery**
102-
5. Click **Login with idp2**
103-
6. Login as an an "about to expire" user, e.g., username=near_future & password=b
104-
7. Click **Maybe later**
105-
8. Click **Logout**
106-
107-
#### Expired
108-
1. Goto [http://ssp-hub.local](http://ssp-hub.local)
109-
2. Click **Authentication** tab
110-
3. Click **Test configured authentication sources**
111-
4. Click **hub-discovery**
112-
5. Click **Login with idp2**
113-
6. Login as an an "expired" user, e.g., username=already_past & password=c
114-
115-
116141
## i18n support
117142
Translations are categorized by page in definition files located in the `dictionaries` directory.
118143

0 commit comments

Comments
 (0)