You are here

README.txt in Fastly 7.2

Same filename in this branch
  1. 7.2 README.txt
  2. 7.2 vcl_snippets/README.txt
Same filename and directory in other branches
  1. 8.3 README.txt
  2. 7 README.txt
Fastly
=======================

https://www.drupal.org/project/fastly

What Is Fastly?
---------------

Fastly is a CDN (Content Delivery Network), which is to say, we speed up
delivery of your website and its content to your users. When your client in
Moscow, Montana or Vriezenveen, Netherlands clicks on your site requesting
a piece of information, we want them to feel your speed of delivery. No
waiting. We want them to get to your closest point of presence—in
milliseconds—to get what they want.

Founded in 2011, Fastly delivers the world's only real-time content delivery
network. At Fastly we think slow is unacceptable. Fastly enables a
next-generation of businesses to give their users the best online and mobile
experience. The patent-pending Fastly Caching Software delivers static,
dynamic and streaming content with the lowest recorded time to first byte.
Our customers include (but certainly aren't limited to) Twitter, Guardian
UK, GitHub, AddThis, Wikia, Shazam, Wanelo, and Yammer.

Fastly is a San Francisco based company, located in the heart of SOMA.
We are venture backed by Battery Ventures, OATV, August Capital, and Amplify
Partners. We provide challenging work, opportunities to learn, high-quality
teammates and, most importantly, we have a lot of fun doing what we love.
We offer some great benefits like a Tahoe ski cabin, stocked fridge,
flexible schedules, lots of company happy hours, and a no-vacation policy.
We are close to MUNI and BART, and Caltrain is just a pleasant 15-minute stroll.

We offer competitive compensation, stock options, and health benefits.


Module Features
---------------

1. Account Sign Up/Sign In. If you are already an authenticated Fastly user,
You can simply enter your API key and service ID to start using Fastly
on your website. If I you are a site admin who wishes to begin using Fastly,
you can simply sign up and configure your service within the module.

2. Automated Purging. Content can be automatically purged when updated/created.
This is done through the Cache Expiration module. Otherwise, purging will occur
at the timeframe (TTL) in which you have specified within the module.

3. Manual purging. You have the ability to set the Time To Live (TTL) for your
content within the Fastly module. You can also take advantage of the default
setting already provided. Also, at anytime you desire, you can click on a button
within the module to manually purge all of the content.


How To Install The Module?
--------------------------

1. Install Fastly (unpacking it to your Drupal
/sites/all/modules directory if you're installing by hand, for example).

2. Enable any Example modules in Admin menu > Site building > Modules.

3. Rebuild access permissions if you are prompted to.

4. Profit! Fastly will appear in your Configuration > Web services menu section.

If you find a problem, incorrect comment, obsolete or improper code or such,
please search for an issue about it at https://www.drupal.org/project/fastly/issues
If there isn't already an issue for it, please create a new one.


SSL and Fastly
--------------
Fastly can support SSL connections.
See http://docs.fastly.com/guides/21844521/23340542 for a list of different
options available.
If you are using SSL, you should add the following lines of code to your
settings.php

// Enable Fastly SSL connections.
if (isset($_SERVER['HTTP_FASTLY_SSL']) && $_SERVER['HTTP_FASTLY_SSL']) {
  $_SERVER['HTTPS'] = 'on';
}


Expire Module Integration
-------------------------
The Fastly module has integration with the Cache Expiration module
(https://www.drupal.org/project/expire).

You can enable this by visiting admin/config/system/expire. You should see
Fastly in the list of modules that support external expiration.
Make sure you select "External expiration".

To alter the purged URLs or add additional URLs, such as URLs on other domains,
implement hook_expire_urls_alter() in a custom module. If you tick "Include base
URL in expires", the absolute URL being purged will be passed into this hook.


Custom VCL
----------
Fastly gives you the ability to upload and use your own VCL file.
This needs to be enabled by contacting Fastly support and requesting it.

This module contains an example.vcl file, this is intended to be used with a
Drupal site running on Fastly. It contains session cookie handling logic,
as well as excluding certain paths from being cached.

If you need to edit the VCL file for whatever reason, please be aware of the
following thing:
* Fastly uses Varnish 2, there are some differences in syntax between 2 and 3.
* Do not include any host information in the VCL, this is added later by Fastly.


HTTPRL Module
-------------
This module supports the HTTP Parallel Request & Threading Library module
(https://www.drupal.org/project/httprl). If installed and enabled, this module
can issue PURGE requests without waiting for a response from Fastly.

File

README.txt
View source
  1. Fastly
  2. =======================
  3. https://www.drupal.org/project/fastly
  4. What Is Fastly?
  5. ---------------
  6. Fastly is a CDN (Content Delivery Network), which is to say, we speed up
  7. delivery of your website and its content to your users. When your client in
  8. Moscow, Montana or Vriezenveen, Netherlands clicks on your site requesting
  9. a piece of information, we want them to feel your speed of delivery. No
  10. waiting. We want them to get to your closest point of presence—in
  11. milliseconds—to get what they want.
  12. Founded in 2011, Fastly delivers the world's only real-time content delivery
  13. network. At Fastly we think slow is unacceptable. Fastly enables a
  14. next-generation of businesses to give their users the best online and mobile
  15. experience. The patent-pending Fastly Caching Software delivers static,
  16. dynamic and streaming content with the lowest recorded time to first byte.
  17. Our customers include (but certainly aren't limited to) Twitter, Guardian
  18. UK, GitHub, AddThis, Wikia, Shazam, Wanelo, and Yammer.
  19. Fastly is a San Francisco based company, located in the heart of SOMA.
  20. We are venture backed by Battery Ventures, OATV, August Capital, and Amplify
  21. Partners. We provide challenging work, opportunities to learn, high-quality
  22. teammates and, most importantly, we have a lot of fun doing what we love.
  23. We offer some great benefits like a Tahoe ski cabin, stocked fridge,
  24. flexible schedules, lots of company happy hours, and a no-vacation policy.
  25. We are close to MUNI and BART, and Caltrain is just a pleasant 15-minute stroll.
  26. We offer competitive compensation, stock options, and health benefits.
  27. Module Features
  28. ---------------
  29. 1. Account Sign Up/Sign In. If you are already an authenticated Fastly user,
  30. You can simply enter your API key and service ID to start using Fastly
  31. on your website. If I you are a site admin who wishes to begin using Fastly,
  32. you can simply sign up and configure your service within the module.
  33. 2. Automated Purging. Content can be automatically purged when updated/created.
  34. This is done through the Cache Expiration module. Otherwise, purging will occur
  35. at the timeframe (TTL) in which you have specified within the module.
  36. 3. Manual purging. You have the ability to set the Time To Live (TTL) for your
  37. content within the Fastly module. You can also take advantage of the default
  38. setting already provided. Also, at anytime you desire, you can click on a button
  39. within the module to manually purge all of the content.
  40. How To Install The Module?
  41. --------------------------
  42. 1. Install Fastly (unpacking it to your Drupal
  43. /sites/all/modules directory if you're installing by hand, for example).
  44. 2. Enable any Example modules in Admin menu > Site building > Modules.
  45. 3. Rebuild access permissions if you are prompted to.
  46. 4. Profit! Fastly will appear in your Configuration > Web services menu section.
  47. If you find a problem, incorrect comment, obsolete or improper code or such,
  48. please search for an issue about it at https://www.drupal.org/project/fastly/issues
  49. If there isn't already an issue for it, please create a new one.
  50. SSL and Fastly
  51. --------------
  52. Fastly can support SSL connections.
  53. See http://docs.fastly.com/guides/21844521/23340542 for a list of different
  54. options available.
  55. If you are using SSL, you should add the following lines of code to your
  56. settings.php
  57. // Enable Fastly SSL connections.
  58. if (isset($_SERVER['HTTP_FASTLY_SSL']) && $_SERVER['HTTP_FASTLY_SSL']) {
  59. $_SERVER['HTTPS'] = 'on';
  60. }
  61. Expire Module Integration
  62. -------------------------
  63. The Fastly module has integration with the Cache Expiration module
  64. (https://www.drupal.org/project/expire).
  65. You can enable this by visiting admin/config/system/expire. You should see
  66. Fastly in the list of modules that support external expiration.
  67. Make sure you select "External expiration".
  68. To alter the purged URLs or add additional URLs, such as URLs on other domains,
  69. implement hook_expire_urls_alter() in a custom module. If you tick "Include base
  70. URL in expires", the absolute URL being purged will be passed into this hook.
  71. Custom VCL
  72. ----------
  73. Fastly gives you the ability to upload and use your own VCL file.
  74. This needs to be enabled by contacting Fastly support and requesting it.
  75. This module contains an example.vcl file, this is intended to be used with a
  76. Drupal site running on Fastly. It contains session cookie handling logic,
  77. as well as excluding certain paths from being cached.
  78. If you need to edit the VCL file for whatever reason, please be aware of the
  79. following thing:
  80. * Fastly uses Varnish 2, there are some differences in syntax between 2 and 3.
  81. * Do not include any host information in the VCL, this is added later by Fastly.
  82. HTTPRL Module
  83. -------------
  84. This module supports the HTTP Parallel Request & Threading Library module
  85. (https://www.drupal.org/project/httprl). If installed and enabled, this module
  86. can issue PURGE requests without waiting for a response from Fastly.