Skip to content
This repository has been archived by the owner on May 16, 2020. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@tabeth
tabeth committed May 29, 2018
1 parent 349206b commit 0de4415
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@ quickly test an endpoint that is not setup to CORS in a CORS fashion.

# Usage
Right now use it by filling out `config.yaml` with the appropriate options (See configuration)
and running the server, e.g. `python xorigin`.
and running the server, e.g. `python xorigin`. Alternatively, you can unzip the
latest [release](https://github.com/experianplc/xorigin/releases) and run `xorigin.exe`
after filling out `config.yaml` and putting it in the same directory as `xorigin.exe`.


# Configuration
`config.yaml` has a few options:
Expand All @@ -26,4 +29,5 @@ and running the server, e.g. `python xorigin`.

`ENDPOINT_PORT`: The port of the endpoint (e.g. 80).

`HEADERS`: Any headers you want the server to include when proxying.
`HEADERS`: Any headers you want the server to include when proxying. By default this
includes headers for aiding with cross origin requests.

0 comments on commit 0de4415

Please sign in to comment.