You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@senssoft.apache.org by rf...@apache.org on 2017/09/08 00:13:41 UTC
[7/7] incubator-senssoft-useralejs git commit: Cleaned up some
grammar, added a gotchas section.
Cleaned up some grammar, added a gotchas section.
Project: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/commit/546f248a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/tree/546f248a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/diff/546f248a
Branch: refs/heads/SENSSOFT-192
Commit: 546f248ad5afb80687161ded4bb82402b4de218b
Parents: ae2f672
Author: Rob Foley <rg...@users.noreply.github.com>
Authored: Thu Sep 7 20:13:24 2017 -0400
Committer: Rob Foley <rg...@users.noreply.github.com>
Committed: Thu Sep 7 20:13:24 2017 -0400
----------------------------------------------------------------------
src/UserALEWebExtension/README.md | 14 ++++++++++++--
1 file changed, 12 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/546f248a/src/UserALEWebExtension/README.md
----------------------------------------------------------------------
diff --git a/src/UserALEWebExtension/README.md b/src/UserALEWebExtension/README.md
index a3a272c..272f5b7 100644
--- a/src/UserALEWebExtension/README.md
+++ b/src/UserALEWebExtension/README.md
@@ -1,9 +1,11 @@
# UserALE Web Extension
-There are many different ways to create extensions for Chrome/Firefox. This project follows the Web Extension way.
+The UserALE.js Web Extension is designed to enable user activity logging across any page they visit, regardless of domain. To achieve this, we repackaged our UserALE.js library into a WebExtension compliant format to allow portability between browsers.
## Folder/file structure
+Here is a rundown of the UserALE Extension hierarchy.
+
* ../
* The parent directory should be the src for the core of UserALE
* README.md
@@ -58,4 +60,12 @@ You can set options for the web extension in your browser by opening the extensi
This version of the web extension has been modified to automatically reflect the correct version of the UserALE core script during the build process. You should not need to change anything for it to "just work".
-However, if something appears wrong, you can look at the 'src/UserAleWebExtension/globals.js' and 'src/UserAleWebExtension/manifest.json' to see how the UserALE client script is being set. Also look at the build steps related to the web extension in 'gulpfile.js' to see how the two previously mentioned files are modified to reflect the current version of the UserALE client script.
\ No newline at end of file
+However, if something appears wrong, you can look at the 'src/UserAleWebExtension/globals.js' and 'src/UserAleWebExtension/manifest.json' to see how the UserALE client script is being set. Also look at the build steps related to the web extension in 'gulpfile.js' to see how the two previously mentioned files are modified to reflect the current version of the UserALE client script.
+
+## Gotchas
+
+There is a known issue when attemping to gather logs from a page running on HTTPS. This occurs due to Mixed Active Content rules in the browser, since the current implementation of the Extension injects the script as HTTP. We are aware of the problem and are actively working towards a fix.
+
+In the meantime, the only workaround is to disable the related security option in the browser:
+* [Chrome](https://superuser.com/questions/487748/how-to-allow-chrome-browser-to-load-insecure-content)
+* [Firefox](https://support.mozilla.org/en-US/kb/mixed-content-blocking-firefox)
\ No newline at end of file