Document Check url about offline HOT 14 CLOSED

Good point. Each way of determining connectedness has its pluses and minuses, no one way is perfect. Offline ships with two methods. One makes a request for a tiny image hosted on my cloudfront account for the benevolence of all, the other makes an XHR request against the current domain, hoping to get back any sort of response (even a 404).

You can change the url of the image to be one you control, if you like:

Offline.options = {checks: {image: {url: 'my-image.gif'}}};

Loading an image was chosen (rather than a script file), because it limits the potential damage if a hostile party were to be in control of it.

You can also switch to the XHR method:

Offline.options = {checks: {active: 'xhr'}}

The XHR method is not enabled by default because of a concern that some sites do a significant amount of processing to build their 404 page, so it's not something we want to send unnecessarily. It's also possible that the page would respond with a redirect to a different domain, creating a CORS problem. If you have control of the domain and can create an endpoint which just responds with a quick 204, that's the perfect solution. You can set the endpoint in settings as well:

Offline.options = {checks: {xhr: {url: '/health-check'}}};

Tomorrow I'll move most of this over to the README proper.

from offline.

Hello and thanks for your nice offline plugin. I'm trying to use the xhr "health check" method but it seems that the plugin is still loading the cloudfround image, rather than the configured url.

Here's the console.log on chrome

Thanks for your help

from offline.

You'll also need to tell it to use the xhr check:

Offline.options = {
  checks: {
    xhr: {
      url: '/health-check'
    },
    active: 'xhr'
  }
};

from offline.

thanks! :-)

from offline.

I just tried and it seems that as soon as you are offline it stucks into a recursive loop, calling the xhr url thousands of times.

from offline.

Just wanted to confirm is below correct

<script type="text/javascript">
    Offline.options = {
        checks: {
            image: {url: '../img/test.gif'}
        },

        requests: false
    }
  </script>     

from offline.

@squallstar Thanks for letting me know, fixed in v0.4.3.

from offline.

@Sifarat

<script type="text/javascript">
    Offline.options = {
        checks: {
            image: {url: '../img/test.gif'},
            active: 'image'
        },

        requests: false
    }
  </script>     

from offline.

that's strange. does not work. the offline message won't go away even after the connection is established.

from offline.

Just out of curiosity, does it work when requests is not disabled?

from offline.

the bug was ',' after the image: {url: '../img/test.gif'},. removing it fixes the issue :)

from offline.

Ah, great!

from offline.

But now requests (false) not working. after I removed above comma

from offline.

I have just replaced cloundfront file with my own in min.js for time being.

from offline.