update docs

Readme.md

 # AAI Login page
 
+## Description
+
 A login page for Php applications with login from multiple AAI organisations.
 It offers a set or organisations (Identity providers) that can be filtered.
 
-With it you can let login people with AAI / EDUGAIN on their own university and giv access tou your server.
+With it you can let login people with AAI / EDUGAIN on their own university and give access tou your server.
 
 📜 License: GNU GPL 3.0 \
 📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/login-aai> \
-📗 Docs: <https://os-docs.iml.unibe.ch/login-aai>
+📗 Docs: <https://os-docs.iml.unibe.ch/login-aai/>
+
 
-⚠️ Work in progress!
+## Screenshots
 
+Mode "boxes":
 ![Login screen with mode "boxes"](docs/images/login_mode_boxes.png)
+
+Mode "list":
+![Login screen with mode "boxes"](docs/images/login_mode_list.png)
+
+Mode "wayf":
+![Login screen with mode "boxes"](docs/images/login_mode_wayf.png)

docs/20_Features.md

@@ -6,3 +6,5 @@
 * A set of filter buttons by TLD will be generated. It is shown when minimum 2 TLDs were found.
 * An active shibboleth session will bedetected and hides the list of organisations
 * Multi language support; English and German language files are part of the project
+* Customizable texts for title, before and after IDP selection
+* customizable CSS

docs/40_Installation.md

@@ -4,14 +4,21 @@
 
 #### Git
 
+```
+cd [your-webroot]
+git clone https://git-repo.iml.unibe.ch/iml-open-source/login-aai.git login_aai
+cd login_aai
+```
+
 #### Manuel steps
 
-* In the webroot create a subfolder "login_aai". 
-* Extract the files there.
+* Download the archive <https://git-repo.iml.unibe.ch/iml-open-source/login-aai/-/archive/main/login-aai-main.zip> (archive formats tar.gz, tar.bz2 and tar are available too).
+* In the webroot create a subfolder "login_aai".
+* Extract the files of the archive there.
 
-## Bring it up
+#### Filestructure
 
-This is the filestructure you get
+This is the filestructure you get:
 
 ```text
 .
@@ -39,11 +46,20 @@ This is the filestructure you get
 └── screen_custom.css.dist
 ```
 
+## Bring it up
+
+### Steps
+
 * Copy **config.php.dist** to config.php and make your changes. See chapter Configuration.
 * Do NOT protect this folder with Shibboleth that it can be accessed anonymous
 * Set a Link for Login to `/login_aai/` where needed
 * For local development see the pade "Development"
 
+### File permissions
+
+* The webserice needs read access.
+* The class creates a cachefile "discofeed.json". If there is no write permission in the appfolder then configure another directory with write permissions.
+
 ## Notes
 
 The web ui offers just a frontend for your visitors to link multiple organisations.
@@ -56,7 +72,7 @@ That the logins at another IDP work you still need to
   * You and your partner need to enablle EDUGAIN.
   * The parter IDP must enable the domain of your website
 
-Links:
+**Links**:
 
 * <https://www.shibboleth.net/>
 * <https://en.wikipedia.org/wiki/Shibboleth_(software)>

docs/50_Configuration.md

@@ -50,19 +50,32 @@ return [
 ];
 ```
 
-| Key | Type         | Description
-|--   |--            |--
+#### Available settings
+
+| Key                | Type    | Description
+|--                  |--       |--
 | title              | string  | Title of the login page; used for title tag and h1 header
-| lang               | string  | Language to detect texts in discofeed as 2 letter code; If the language is not found it takes the 1st text item
+| lang               | string  | Language as 2 letter code for ui and to detect texts in discofeed; If the language is not found in the discofeed it takes the 1st text item
 | mode               | string  | Selection mode; one of <br>- `"boxes"` Boxes with images incl. filter field<br>- `"list"` Top down list of IDPs with images incl. filter field<br>- `"wayf"` Selection with WAYF script from Switch
 | text-info          | string  | When not empty: show a warning banner with its text on top eg. for maintenance messages
 | text-before-wayf   | string  | Text to show before wayf select box (for mode = "wayf" only)
 | text-after-logins  | string  | Fisnishing text after
 | idps               | array   | List of enabled idps to whitelist; it will filtered by enabled organisatzions by shibboleth
 | return-url         | string  | Return url to your application afer logging in on then organization url<br>- '/shib_login.php' is for Ilias LMS
-| cachefile          | string  | Releative path for cache file; default: discofeed.json
+| cachefile          | string  | Releative path for cache file of the discofeed; default: "discofeed.json"; the user of webserver (www-data, ...) needs write permission in the follder
 | cachettl           | integer | Caching time for cache file (discofeed.json ); default: 60 min
 
+#### Screenshots of modes
+
+Mode "boxes":
+![Login screen with mode "boxes"](images/login_mode_boxes.png)
+
+Mode "list":
+![Login screen with mode "boxes"](images/login_mode_list.png)
+
+Mode "wayf":
+![Login screen with mode "boxes"](images/login_mode_wayf.png)
+
 ### Custom Css
 
 Place a file named "screen_custom.css". If this exists it will be added in the html code after all other css files. There you can override all styles and values.
@@ -72,5 +85,5 @@ Place a file named "screen_custom.css". If this exists it will be added in the h
 If you want to modify the look of the Idp selection:
 
 * go to directory "mode"
-* Make a copy of a view, eg. copy "boxes" to "myboxes" and make your changes in the copy
-* To activate edit the ./config.php and set `'mode' => 'myboxes',`
+* Make a copy of a view, eg. copy "boxes" to "myboxes" and make your changes for coding and styling in your copy
+* To activate it edit the ./config.php and set `'mode' => 'myboxes',`

docs/_index.md

-# AAI Login page
-
-A login page for Php applications with login from multiple AAI organisations.
+<html>
+<div class="hero">
+    <h2>AAI Login page</h2>
+    A customizable login page with login from multiple AAI organisations.
+</div>
+</html>
+
+A customizable login page for Php applications with login from multiple AAI organisations.
 It offers a set or organisations (Identity providers) that can be filtered.
 
-With it you can let login people with AAI / EDUGAIN on their own university and giv access tou your server.
+With it you can let login people with AAI / EDUGAIN on their own university and give access tou your web application.
 
 📜 License: GNU GPL 3.0 \
 📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/login-aai> \
-📗 Docs: <https://os-docs.iml.unibe.ch/login-aai>
-
+📗 Docs: <https://os-docs.iml.unibe.ch/login-aai/>
\ No newline at end of file
-⚠️ Work in progress!
-
-![Login screen with mode "boxes"](images/login_mode_boxes.png)
\ No newline at end of file

docs/config.json

@@ -17,8 +17,8 @@
             "basepath": "https://git-repo.iml.unibe.ch/iml-open-source/login-aai/-/tree/main/docs"
         },
         "links": {
-            "Git Repo": "__GITURL__",
-            "IML Opensource": "https://os-docs.iml.unibe.ch/"
+            "Git Repo": "https://git-repo.iml.unibe.ch/iml-open-source/login-aai.git",
+            "IML Opensource": "https://os-docs.iml.unibe.ch/login-aai/"
         },
         "theme": "daux-blue",
         "search": true