Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename H_SERVICE_URL to SIDEBAR_APP_URL #454

Merged
merged 1 commit into from
Jun 19, 2017
Merged

Rename H_SERVICE_URL to SIDEBAR_APP_URL #454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/developers/developing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 5 additions & 3 deletions docs/developers/envvars.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/developers/mobile.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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>

Expand Down
4 changes: 2 additions & 2 deletions gulpfile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down