box / box-content-preview

JavaScript library for rendering files stored on Box
https://developer.box.com/docs/box-content-preview
Other
106 stars 113 forks source link

feat(remote-sync): Enable remote syncing based on an API response #1506

Closed TylerGauntlett closed 1 year ago

TylerGauntlett commented 1 year ago

Why?

The current rsync.json file only supports a statically defined location. This works find for statically defined host/IP addresses but doesn't work well if the remote source goes through another proxy layer (ie K8 ingress, reverse proxy, etc)

How?

To resolve this, I added the ability to define a host/IP address from the result of an API call. This expands on the current rsync.json file while preserving backwards compatablity.

Example

{
    "apiLocation": {
        "url": "https://example-website/api/info",
        "user": "root",
        "ip": "serverIpAddress",
        "path": "/var/www/assets/example-website"
    }
}
CLAassistant commented 1 year ago

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Tyler Gauntlett seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.