{"id":40386075,"url":"https://github.com/rciam/simplesamlphp-module-themevanilla","last_synced_at":"2026-01-20T12:08:18.505Z","repository":{"id":45297098,"uuid":"108548762","full_name":"rciam/simplesamlphp-module-themevanilla","owner":"rciam","description":"A customisable vanilla theme for SimpleSAMLphp","archived":false,"fork":false,"pushed_at":"2024-01-12T14:21:53.000Z","size":3273,"stargazers_count":4,"open_issues_count":0,"forks_count":6,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-01-12T20:37:28.437Z","etag":null,"topics":["bootstrap","module","simplesamlphp","theme"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rciam.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-10-27T13:20:47.000Z","updated_at":"2024-01-12T14:13:57.000Z","dependencies_parsed_at":"2023-12-21T10:51:35.175Z","dependency_job_id":"196ef070-9b9a-4abe-86b8-9f878bc696f1","html_url":"https://github.com/rciam/simplesamlphp-module-themevanilla","commit_stats":null,"previous_names":[],"tags_count":12,"template":null,"template_full_name":null,"purl":"pkg:github/rciam/simplesamlphp-module-themevanilla","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rciam%2Fsimplesamlphp-module-themevanilla","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rciam%2Fsimplesamlphp-module-themevanilla/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rciam%2Fsimplesamlphp-module-themevanilla/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rciam%2Fsimplesamlphp-module-themevanilla/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rciam","download_url":"https://codeload.github.com/rciam/simplesamlphp-module-themevanilla/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rciam%2Fsimplesamlphp-module-themevanilla/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28603386,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T12:01:53.233Z","status":"ssl_error","status_checked_at":"2026-01-20T12:01:46.545Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bootstrap","module","simplesamlphp","theme"],"created_at":"2026-01-20T12:08:18.440Z","updated_at":"2026-01-20T12:08:18.494Z","avatar_url":"https://github.com/rciam.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vanilla theme for SimpleSAMLphp\n\n![discopower](screenshots/disco_buttons_bottom.png)\n\nA customisable theme for SimpleSAMLphp based on Bootstrap.\nSee more screens in the directory [screenshots](screenshots/).\n\n## Installation\n\nYou can install the theme using any of the methods below.\n\n### Composer\n\nIf you want to use [composer](https://getcomposer.org/) to install this theme\nyou need to edit `composer.json`. The file is located in your SimpleSAMLphp\ninstallation. Check the following example, that includes all the necessary\nadditions for the installation of the **simplesamlphp-module-themevanilla\nv1.0.0**.\n\n```json\n\"require\": {\n\n  ...\n\n  \"rciam/simplesamlphp-module-themevanilla\": \"1.0.0\",\n  \"rciam/css\": \"1.0.0\",\n  \"rciam/js\": \"1.0.0\"\n},\n\"repositories\": [\n\n  ...\n\n  {\n    \"type\": \"vcs\",\n    \"url\": \"https://github.com/rciam/simplesamlphp-module-themevanilla\"\n  },\n  {\n    \"type\": \"package\",\n    \"package\": {\n      \"name\": \"rciam/css\",\n      \"version\": \"1.0.0\",\n      \"dist\": {\n        \"type\": \"zip\",\n        \"url\": \"https://github.com/rciam/simplesamlphp-module-themevanilla/releases/download/v1.0.0/css.zip\"\n      }\n    }\n  },\n  {\n    \"type\": \"package\",\n    \"package\": {\n      \"name\": \"rciam/js\",\n      \"version\": \"1.0.0\",\n      \"dist\": {\n        \"type\": \"zip\",\n        \"url\": \"https://github.com/rciam/simplesamlphp-module-themevanilla/releases/download/v1.0.0/js.zip\"\n      }\n    }\n  }\n],\n\"scripts\": {\n\n  ...\n\n  \"post-update-cmd\": [\n    \"cp -r 'vendor/rciam/css' 'modules/themevanilla/www/resources'\",\n    \"cp -r 'vendor/rciam/js' 'modules/themevanilla/www/resources'\",\n    \"cp 'modules/themevanilla/config-example/module_themevanilla.php' 'config/module_themevanilla.php'\"\n  ]\n},\n```\n\nWith the above configuration composer will do several operations:\n\n- It will put the module `themevanilla` in the `modules` directory.\n- It will download and extract the compressed `css` and `js` directories that\n  include the minified css and javascript files.\n- It will copy the `css` and `js` directories from the `vendor/rciam` directory\n  in the `themevanilla/www/resources` directory, where the static files of the\n  theme should be placed.\n- It will place the configuration file `module_themevanilla.php` inside the\n  `config` directory of the installation.\n\n### Direct download\n\nYou can download `themevanilla.zip` from the [release page](https://github.com/rciam/simplesamlphp-module-themevanilla/releases).\nDownload the zip file of the preferred release and extract its contents in the\n`modules` directory of your SimpleSAMLphp installation.\nFinally, move `example-config/module_themevanilla.php` file to the `config` directory\nof your SimpleSAMLphp installation.\n\n### Clone repository\n\nClone this repository into the `modules` directory of your SimpleSAMLphp\ninstallation as follows:\n\n```sh\ncd /path/to/simplesamlphp/modules\ngit clone https://github.com/rciam/simplesamlphp-module-themevanilla.git themevanilla\n```\n\nNote that the cloned repository will not include the css files or minified\njavascript files.\nYou'll need to download or produce them. You can download the compressed\ndirectories (`js.zip` and `css.zip`) from the [release page](https://github.com/rciam/simplesamlphp-module-themevanilla/releases)\nand extract them under `modules/themevanilla/www/resources`. If you want to\nproduce them, you may read the customisation instructions below.\nAs a last step, move `example-config/module_themevanilla.php` file to the `config`\ndirectory of your SimpleSAMLphp installation.\n\n## Configuration\n\n### Basic usage\n\nIn order to use this module as theme you need to set in the\n`config/config.php`: `'theme.use' =\u003e 'themevanilla:ssp'`\n\n### Using IdP login buttons with icons\n\nThe theme splits the discopower IdP discovery page into 2 sections, depending on\nthe tags of the included IdPs:\n\n- The section that its IdPs have the tag `idps_in_searchable_list` contains all\n  the IdPs in a list of links with a search box.\n- The section that its IdPs have the tag `idps_with_logos` contains login\n  buttons with specified style rules for each IdP. Each button may have a logo\n  icon, too.\n\nAlso, you need to define the order of the 2 sections. You can set this in the\nfile `config/module_discopower.php` from the variable `taborder`.\nFor example:\n\n```php\n'taborder' =\u003e [\n  'idps_in_searchable_list',\n  'idps_with_logos'\n]\n```\n\nEspecially for the of the `idps_with_logos`, you need to specify the css class\nname, icon and label of the IdP login button using the `login_button`\nconfiguration as follows:\n\n```php\n'tags' =\u003e [\n  'idps_with_logos',\n],\n'login_button' =\u003e [\n  'css_classname' =\u003e 'orcid',\n  'icon_filename' =\u003e 'orcid.svg',\n  'label' =\u003e 'ORCID',\n]\n```\n\nTo set style rules for the each button, the configured css_classname value must\nbe defined in the `idps_buttons.scss` file. See more information bellow.\n\nAt the moment there are style rules for the IdPs:\n\n- ARIA\n- B2ACCESS\n- Check-in\n- DARIAH\n- eduTEAMS\n- Elixir\n- Facebook\n- Google\n- IGTF\n- LinkedIn\n- ORCID\n- OpenAIRE\n- OpenMinTeD\n\n### Cookie Policy\n\nCookie policy includes a banner at the bottom of each page that prompts the\nuser to accept the cookies, along with a Cookies Policy page.\nThe feature is disabled by default.\nTo enable it, set `enable_cookies_banner` to `true` in the configuration file:\n`\u003cpath-to-simplesamlphp\u003e/config/module_themevanilla.php`.\n\n## Customization\n\n### Wording\n\nYou can find definitions and dictionaries in the `dictionaries` directory.\n\n### Images\n\nPlace your logo and favicon in the directory:\n`themevanilla/www/resources/images` If you name them `logo.jpg` and\n`favicon.ico` they will be loaded without any other modification. If you name\nthem differently you need to modify the template `header.php` that is placed in:\n`themevanilla/themes/ssp/default/includes/`.\n\nBy default, the logo has height 60px. See below how you can modify it.\n\n### Header logo link\n\nYou can customise the url of the link of the logo in the header by changing\nthe `logo_link_url` definition in `dictionaries/default.definition.json` file.\n\n### Footer\n\nIf you want to make any changes in the footer you need to modify the template\n`footer.php` that is placed in: `themevanilla/themes/ssp/default/includes/`.\n\n### Header ribbon\n\nThe text in the header ribbon can be altered by changing the `ribbon_text`\ndefinition in `module_themevanilla.php` file.\nIf you want to hide the ribbon, set `ribbon_text` to `\"\"`.\n\n### CSS\n\nTo produce the css files for this theme follow these steps:\n\n- Install sass ([installation guide](http://sass-lang.com/install))\n- Go to the directory `themevanilla/www/resources`\n- Run the cli sass: `sass --update sass:css`\n\nAfter these steps the css files will be in the directory\n`themevanilla/www/resources/css`\n\nYou can change the settings of this theme from the files:\n\n- `themevanilla/www/resources/sass/_settings.scss`: Here you will see the\n  following variables:\n\n  - $btn-action: background color of primary button\n  - $btn-warning: background color of warning button\n  - $footer-bg: footer background color\n  - $footer-text: color of the text in the footer\n  - $footer-link: color of the links in the footer\n  - $btn-footer-text: text color of button that is in the footer\n  - $btn-footer-border: border color of button that is in the footer\n\n- `themevanilla/www/resources/sass/_colors.scss`: Here you can add or change\n  color settings.\n\n- `themevanilla/www/resources/sass/_idps_buttons.scss`: Here you can add or\n  modify settings that are related with the buttons of the selected subset of\n  IdPs.\n\nAfter you change any of these files you need to produce the css file that the\nbrowser will serve. You can do that by running: `sass --update sass:css`, as\nmentioned above.\n\nPlease, check the help page of the cli tool sass if you want to use more\ncompiling options.\n\n### Cookie Policy\n\nTo modify the cookie banner and cookie policy page, you must edit the following files:\n`\u003cpath-to-module\u003e/dictionaries/policy.definition.json`\nand to modify the table in cookie policy page:\n`\u003cpath-to-simplesamlphp\u003e/config/module_themevanilla.php`.\n\n## About SimpleSAMLphp themes\n\nYou can read more about themes in a SimpleSAMLphp installation from the\n[official documentation](https://simplesamlphp.org/docs/stable/simplesamlphp-theming).\n\n## Compatibility matrix\n\nThis table matches the theme version with the supported SimpleSAMLphp version.\n\n| Theme | SimpleSAMLphp | Discopower |\n|:-----:|:-------------:|:----------:|\n| v1.x  |     v1.14     |     -      |\n| v2.x  |     v1.14     |     -      |\n| v3.x  |     v1.17     |     -      |\n| v4.x  |       -       |   v0.9.2   |\n\n## License\n\nLicensed under the Apache 2.0 license, for details see `LICENSE`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frciam%2Fsimplesamlphp-module-themevanilla","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frciam%2Fsimplesamlphp-module-themevanilla","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frciam%2Fsimplesamlphp-module-themevanilla/lists"}