Skip to content

docs: update README with new CDN url #48

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

Open
Gaudv wants to merge 1 commit into
base: staging
Choose a base branch
from
Open

docs: update README with new CDN url #48

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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ The aim of this project is to provide a means to separate the installer configur

The configuration is defined in the `config.ts` file.

Once merged to staging, the configuration is automatically deployed to the CDN (`https://cdn.flybywiresim.com/installer/config/staging.json`).
Once merged to staging, the configuration is automatically deployed to the CDN (`https://flybywirecdn.com/installer/config/staging.json`).

A maintainer can then manually deploy the configuration to the production branch (`https://cdn.flybywiresim.com/installer/config/production.json`).
A maintainer can then manually deploy the configuration to the production branch (`https://flybywirecdn.com/installer/config/production.json`).

## Contributing

Expand All @@ -23,7 +23,7 @@ To change the configuration, please submit a pull request with your changes to t

To build the configuration locally, run `npm run build <filename>`. The resulting json file will be placed in the `dist` folder. This is only for testing purposes. You can use the file to test your configuration locally by using this URL: `file://{path to json file}`

If a PR is created from a branch of the main repo (and not a fork) the configuration will be automatically build and deployed to the CDN. The URL will be `https://cdn.flybywiresim.com/installer/config/pr-<PR-NUMBER>.json`.
If a PR is created from a branch of the main repo (and not a fork) the configuration will be automatically build and deployed to the CDN. The URL will be `https://flybywirecdn.com/installer/config/pr-<PR-NUMBER>.json`.

For testing the PR configuration copy the URL and paste it into the installer configuration URL field in the installer settings. Ask on the FlyByWire's Discord [#installer](https://discord.com/channels/738864299392630914/757387126173204540) channel on how to do this.

Expand Down