Skip to content

Commit 3520419

Browse files
committed
Clarify usage of module config file in README
1 parent dc58030 commit 3520419

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,8 @@ v1.0.0**.
6464
6565
"post-update-cmd": [
6666
"cp -r 'vendor/rciam/css' 'modules/themevanilla/www/resources'",
67-
"cp -r 'vendor/rciam/js' 'modules/themevanilla/www/resources'"
67+
"cp -r 'vendor/rciam/js' 'modules/themevanilla/www/resources'",
68+
"cp 'modules/themevanilla/config-example/module_themevanilla.php' 'config/module_themevanilla.php'"
6869
]
6970
},
7071
```
@@ -76,12 +77,16 @@ With the above configuration composer will do several operations:
7677
* It will copy the `css` and `js` directories from the `vendor/rciam` directory
7778
in the `themevanilla/www/resources` directory, where the static files of the
7879
theme should be placed.
80+
* It will place the configuration file `module_themevanilla.php` inside the
81+
`config` directory of the installation.
7982

8083
### Direct download
8184

8285
You can download `themevanilla.zip` from the [release page](https://github.com/rciam/simplesamlphp-module-themevanilla/releases).
8386
Download the zip file of the preferred release and extract its contents in the
8487
`modules` directory of your SimpleSAMLphp installation.
88+
Finally, move `example-config/module_themevanilla.php` file to the `config` directory
89+
of your SimpleSAMLphp installation.
8590

8691
### Clone repository
8792

@@ -97,16 +102,9 @@ You'll need to download or produce them. You can download the compressed
97102
directories (`js.zip` and `css.zip`) from the [release page](https://github.com/rciam/simplesamlphp-module-themevanilla/releases) and
98103
extract them under `modules/themevanilla/www/resources`. If you want to produce
99104
them, you may read the customisation instructions below.
105+
As a last step, move `example-config/module_themevanilla.php` file to the `config`
106+
directory of your SimpleSAMLphp installation.
100107

101-
### Cookie Policy
102-
103-
In order to use Cookie Policy page you must copy the configuration file
104-
from the `config-example` folder to core config directory.
105-
```
106-
cp <path-to-module>/config-example/module_themevanilla.php <path-to-simplesamlphp>/config
107-
```
108-
To disable the feature, set `enable_cookies_banner` to `false` in the above
109-
file.
110108

111109
## Configuration
112110

@@ -168,11 +166,12 @@ At the moment there are style rules for the IdPs:
168166

169167
### Cookie Policy
170168

171-
In order to use Cookie Policy page you must copy the configuration file
172-
from the `config-example` folder to core config directory.
173-
```
174-
cp <path-to-module>/config-example/module_themevanilla.php <path-to-simplesamlphp>/config
175-
```
169+
Cookie policy includes a banner at the bottom of each page that prompts the user to
170+
accept the cookies, along with a Cookies Policy page.
171+
The feature is disabled by default.
172+
To enable it, set `enable_cookies_banner` to `true` in the configuration file:
173+
`<path-to-simplesamlphp>/config/module_themevanilla.php`.
174+
176175

177176
## Customization
178177

0 commit comments

Comments
 (0)