diff --git a/README.md b/README.md index 1b6820d7..891458fd 100755 --- a/README.md +++ b/README.md @@ -149,14 +149,14 @@ For detailed explanations, please visit the [documentation](https://oil.axelspri | Config Parameter | Description | Default Setting | |----------|---------------|-------| -| publicPath | The server path from which all chunks and ressources will be loaded. You should upload all released files there and configure it. | None, required +| publicPath | The server path from which all chunks and ressources will be loaded. You should upload all released files there and configure it. | `//unpkg.com/@ideasio/oil.js@{oilVersion}/dist/latest/` | locale | Object including locale version, id and labels. You can define the standard labels for all legal texts and buttons and set a version for it. See [here for a configuration example](#texts-locale-object) and [here for all localizable labels](#available-text-labels) | None | locale_url | As an alternative to passing a locale object, set this to a JSON file with the locale configuration. See [here for an example file](https://github.com/as-ideas/oil/blob/master/test/fixtures/config/deDE_01_locale.json) | None | preview_mode | The preview mode is useful when testing OIL in a production or live environment. When value is `true`, the layer remains hidden until you manually trigger `window.AS_OIL.previewModeOn()` in your console. Reload, and the layer is displayed. You can hide it again with `window.AS_OIL.previewModeOff()`. | false | theme | The theme for the layer. By default there are two themes, 'dark' and 'light', with 'light' beeing the default. The theme currently works only as an additional css class. If you want to change the style or theme, please look into the styling guide in the development section. | 'light' | poi_activate_poi | Activates single consent cookie for multiple websites. [See requirements for POI here](#poi--power-opt-in) | false -| poi_hub_origin | The origin of the hub.js installation | None -| poi_hub_path | The path to the hub.html installation on the origin, if any. | /hub.html +| poi_hub_origin | The origin of the hub.js installation | `https://unpkg.com` +| poi_hub_path | The path to the hub.html installation on the origin, if any. | `/@ideasio/oil.js@{oilVersion}/dist/latest/hub.html` | poi_group_name | POI group name. POI only affects those sites with the same group name (mandatory if POI is activated). The group name must be valid (existing). | none | poi_subscriber_set_cookie | Whether to set the SOI cookie on POI opt-ins or not. | true | cookie_expires_in_days | Value in days until the domain cookie used to save the users decision in days | 31 diff --git a/docs/src/docs/02-quickstart.adoc b/docs/src/docs/02-quickstart.adoc index 43e082d9..4ca454c2 100644 --- a/docs/src/docs/02-quickstart.adoc +++ b/docs/src/docs/02-quickstart.adoc @@ -93,7 +93,7 @@ This unpkg.com URL always points to the latest version. See unpkg.com help to lo === Configure OIL To ensure that your self-hosted OIL can find all its necessary scripts you must define the `publicPath` parameter in your <>. -It specifies the server path from which all chunks and ressources will be loaded. This is a minimal configuration tag: +It specifies the server path from which all chunks and resources will be loaded. This is a minimal configuration tag: [source,html,subs="attributes"] ---- @@ -114,7 +114,7 @@ Note that you will have to add your own locale to the configuration block. See < ---- <script id="oil-configuration" type="application/configuration"> { - "publicPath": "//unpkg.com/@ideasio/oil.js/dist/latest/", + "publicPath": "https://unpkg.com/@ideasio/oil.js/dist/latest/", "locale": { localeId: "myLocale", version: "1", texts: {"label_intro_heading":"I am a stub" }} } </script> diff --git a/docs/src/docs/03-configuration.adoc b/docs/src/docs/03-configuration.adoc index e5ef40e9..32d7df73 100644 --- a/docs/src/docs/03-configuration.adoc +++ b/docs/src/docs/03-configuration.adoc @@ -130,13 +130,13 @@ This is a full list of configurable options. | <> | Object including locale version, id and labels. You can define the standard labels for all legal texts and buttons and set a version for it. <> | None | locale_url | As an alternative to passing a locale object, set this to a JSON file with the locale configuration. See link:https://github.com/as-ideas/oil/blob/master/test/fixtures/config/deDE_01_locale.json[See here for an example file] | None | persist_min_tracking | If minimum tracking should result in removing all OIL cookies from the users browser and close the layer and store this selection in the oil cookie. | true -| poi_activate_poi | Activates or disactivates Power Opt-In. | false +| poi_activate_poi | Activates or deactivates Power Opt-In. | false | poi_group_name | POI group name. POI only affects those sites with the same group name (mandatory if POI is activated). | none -| poi_hub_origin | The origin of the hub.js installation, if any. | None -| poi_hub_path | The path to the hub.html installation on the origin, if any. | /hub.html +| poi_hub_origin | The origin of the hub.js installation | `https://unpkg.com` +| poi_hub_path | The path to the hub.html installation on the origin, if any. | `/@ideasio/oil.js@{version}/dist/latest/hub.html` | poi_subscriber_set_cookie | Whether to set the SOI cookie on POI opt-ins or not. | true | <> | The preview mode is useful when testing OIL in a production or live environment. As a dev you can trigger the overlay by setting a cookie named "oil_preview" with the value "true". This will show the OIL layer on your client. | false -| publicPath | The server path from which all chunks and ressources will be loaded. You should upload all released files there and configure it. | None, required +| publicPath | The server path from which all chunks and resources will be loaded. You should upload all released files there and configure it. | `https://unpkg.com/@ideasio/oil.js@{version}/dist/latest/hub.html` | require_optout_confirm | Flag to activate the opt-out confirmation dialog within Cookie Preference Center. If set to `true`, addition label definitions (for labels with prefix `label_cpc_purpose_optout_confirm`) are required. See section <> for details. | false | show_limited_vendors_only | Flag to only show the vendors limited by `iabVendorWhitelist` or `iabVendorBlacklist` in the CPC | false | theme | The theme for the layer. By default there are two themes and size modifier themes, `dark` and `light` as well as `small dark` and `small light`. Themes currently work only as an additional css class. To change the style or theme, look into the <>. | light @@ -312,7 +312,7 @@ For example adding the class ``as-js-companyList`` will add a click handler, whi === preview_mode -The preview mode is useful when testing OIL in a production or live environment. When in preview_mode, the consent layer remains hidden until you manually control its display using the following commands. +The preview mode is useful when testing OIL in a production or live environment. When in preview_mode, the consent layer remains hidden until you manually control its display using the following commands. Run this in the console to show the OIL layer on your client: diff --git a/etc/webpack.release.js b/etc/webpack.release.js index 94bc057b..75362454 100755 --- a/etc/webpack.release.js +++ b/etc/webpack.release.js @@ -12,7 +12,7 @@ let config = webpackMerge(prodConfig, { output: { // the public path which is used by all System.require - publicPath: `//unpkg.com/@ideasio/oil.js@${process.env.npm_package_version}/dist/latest/`, + publicPath: `https://unpkg.com/@ideasio/oil.js@${process.env.npm_package_version}/dist/latest/`, } }); diff --git a/src/scripts/core/core_config.js b/src/scripts/core/core_config.js index aa3bc9a7..8b68f7ae 100644 --- a/src/scripts/core/core_config.js +++ b/src/scripts/core/core_config.js @@ -129,7 +129,7 @@ export function isSubscriberSetCookieActive() { * @returns {string, null} domain iframe orgin */ export function getHubOrigin() { - let origin = getConfigValue(OIL_CONFIG.ATTR_HUB_ORIGIN, '//unpkg.com'); + let origin = getConfigValue(OIL_CONFIG.ATTR_HUB_ORIGIN, 'https://unpkg.com'); if (origin) { return origin.indexOf('http') !== -1 ? origin : location.protocol + origin; }