Merge pull request #454 from hypothesis/rename-H_SERVICE_URL-to-SIDEB…

…AR_APP_URL Rename H_SERVICE_URL to SIDEBAR_APP_URL
hypothesis · Jun 19, 2017 · f213843 · f213843
2 parents 9be0257 + d055895
commit f213843
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 8 deletions.
diff --git a/docs/developers/developing.rst b/docs/developers/developing.rst
@@ -83,7 +83,7 @@ run:
 
 .. code-block:: sh
 
-   export H_SERVICE_URL=http://localhost:5000
+   export SIDEBAR_APP_URL=http://localhost:5000/app.html
    gulp watch
 
 **In the `hypothesis/h` repository**, set the :envvar:`CLIENT_URL` env var to

diff --git a/docs/developers/envvars.rst b/docs/developers/envvars.rst
@@ -4,10 +4,12 @@ Environment Variables
 This section documents all the environment variables supported by the client's
 build tasks.
 
-.. envvar:: H_SERVICE_URL
+.. envvar:: SIDEBAR_APP_URL
 
-   The URL of the service which hosts the HTML entry point for the client's
-   sidebar application.
+   The default value for the :option:`sidebarAppUrl` config setting (the URL of
+   the sidebar app's iframe), used when the host page does not contain a
+   :option:`sidebarAppUrl` setting.
+   ``https://hypothes.is/app.html`` by default.
 
 .. envvar:: PACKAGE_SERVER_HOSTNAME
 

diff --git a/docs/developers/mobile.rst b/docs/developers/mobile.rst
@@ -39,7 +39,7 @@ tested with at least current versions of iOS Safari and Chrome for Android.
 
       make dev
 
-#. Set the :envvar:`H_SERVICE_URL` and :envvar:`PACKAGE_SERVER_HOSTNAME`
+#. Set the :envvar:`SIDEBAR_APP_URL` and :envvar:`PACKAGE_SERVER_HOSTNAME`
    environment variables to load assets from this hostname and start the dev
    server:
 
@@ -48,7 +48,7 @@ tested with at least current versions of iOS Safari and Chrome for Android.
       # In the client repository
 
       # Set URL which sidebar app ("app.html") is loaded from
-      export H_SERVICE_URL=http://<HOSTNAME>:5000
+      export SIDEBAR_APP_URL=http://<HOSTNAME>:5000/app.html
       # Set hostname used when generating client asset URLs
       export PACKAGE_SERVER_HOSTNAME=<HOSTNAME>
 

diff --git a/gulpfile.js b/gulpfile.js
@@ -264,8 +264,8 @@ var isFirstBuild = true;
 function generateBootScript(manifest) {
   var { version } = require('./package.json');
 
-  var defaultSidebarAppUrl = process.env.H_SERVICE_URL ?
-    `${process.env.H_SERVICE_URL}/app.html` : 'https://hypothes.is/app.html';
+  var defaultSidebarAppUrl = process.env.SIDEBAR_APP_URL ?
+    `${process.env.SIDEBAR_APP_URL}` : 'https://hypothes.is/app.html';
 
   var defaultAssetRoot;