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

Fix readme #108

Merged
merged 3 commits into from
Oct 20, 2020
Merged

Fix readme #108

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2ca8aa8
fix: use GitHub friendly anchor
honnix Oct 20, 2020
71ed7ff
fix: add example how to use cors proxy
honnix Oct 20, 2020
df3d676
fix: describe how to use dotenv
honnix Oct 20, 2020
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
10 changes: 7 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ can be installed by running ``yarn`` in the project directory.
Environment variables
======================
Before we can run the server, we need to set up an environment variable or two.
Environment variables can be set either in the current shell or persisted in
``.env`` file stored under the root of the repository.

``ADMIN_API_URL`` (default: `window.location.origin <https://developer.mozilla.org/en-US/docs/Web/API/Window/location>`_)

Expand Down Expand Up @@ -61,7 +63,7 @@ usually not needed, so the default behavior is to run without a prefix.

``CORS_PROXY_PREFIX`` (default: ``/cors_proxy``)

Sets the local endpoint for `CORS request proxying <cors-proxy_>`_.
Sets the local endpoint for `CORS request proxying <cors-proxying_>`_.

===============
Run the server
Expand Down Expand Up @@ -112,7 +114,7 @@ a single module, you can specify that one specifically
(ex. ``localStorage.debug = 'flyte:adminEntity'`` to only see decoded Flyte
Admin API requests).

.. _cors-proxy:
.. _cors-proxying:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess either GitHub doesn't read this or there is some sort of weird logic. This change basically makes the custom anchor being the same as what is generated by GitHub from section header.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh huh. That is strange.


==============
CORS Proxying
Expand All @@ -126,7 +128,9 @@ hosting the Admin API on a different domain than the console. Another example is
when fetching execution data from external storage such as S3. This is done to
minimize the amount of extra configuration required for ingress to the Admin API
and data storage, as well as to simplify local development of the console without
the need to grant CORS access to ``localhost``.
the need to grant CORS access to ``localhost``. To proxy requests for local
development, set ``ADMIN_API_URL`` to
``http://localhost:3000/cors_proxy/http://<admin-host>:<admin-port>``.

The requests and responses are piped through the NodeJS server with minimal
overhead. However, it is still recommended to host the Admin API and console on
Expand Down