You are here

Home » API reference » Fastly 8.3

README.txt in Fastly 8.3

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

http://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 In. If you are already an authenticated Fastly user,
You can simply enter an API token and a list of service will show up in a
drop down.

2. Automated Purging. Content will be automatically purged when updated/created.
This is done using Drupal 8's CacheTagsInvalidatorInterface.

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

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

2. Fastly will appear in your Configuration > Web services menu section.

3. Enter your Fastly API token in the settings form and then select your service.

4. *IMPORTANT* Make sure you click Upload Fastly VCL snippets. Although this step is not
required it improves caching and enables features such as serve stale on errors etc.

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

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

// Enable Fastly TLS connections.
if (!empty($_SERVER['HTTP_FASTLY_SSL'])) {
  $_SERVER['HTTPS'] = 'on';
}

FASTLY API TOKEN
________________
You can change it in settings form or you can use environment variable FASTLY_API_TOKEN to set it also.

FASTLY SERVICE ID
_________________
A Service represents the configuration for your website to be served through Fastly. You can override this with
FASTLY_API_SERVICE environment variable

FASTLY SITE ID
______________
Site identifier which is being prepended to cache tags. You can change it in settings form. Use this if you have
multiple sites in the same service in Fastly. Note: You can use the environment variable FASTLY_SITE_ID
to set this also. If nothing is set in either config or environment variable then one will be randomly generated for
you.

FASTLY CACHE TAG HASH LENGTH
____________________________

For sites with more content, it may be necessary to increase the length of the hashed cache tags that are used for the
<code>Surrogate-Key</code> header and when purging content. You can change it in settings form.
This is due to hash collisions (https://en.wikipedia.org/wiki/Hash_table#Collision_resolution) which will result in
excessive purging of content if the key length is too short.
Note that this number should not be as large as the total number of cache tags in your site, just high enough to
avoid most collisions during purging. Also you can override this with environment variable FASTLY_CACHE_TAG_HASH_LENGTH.

File

README.txt
View source 
  1. Fastly

  2. =======================

  3. 

  4. http://drupal.org/project/fastly

  5. 

  6. What Is Fastly?

  7. ---------------

  8. 

  9. Fastly is a CDN (Content Delivery Network), which is to say, we speed up

  10. delivery of your website and its content to your users. When your client in

  11. Moscow, Montana or Vriezenveen, Netherlands clicks on your site requesting

  12. a piece of information, we want them to feel your speed of delivery. No

  13. waiting. We want them to get to your closest point of presence—in

  14. milliseconds—to get what they want.

  15. 

  16. Founded in 2011 Fastly delivers the world's only real-time content delivery

  17. network. At Fastly we think slow is unacceptable. Fastly enables a

  18. next-generation of businesses to give their users the best online and mobile

  19. experience. The patent-pending Fastly Caching Software delivers static,

  20. dynamic and streaming content with the lowest recorded time to first byte.

  21. Our customers include (but certainly aren't limited to) Twitter, Guardian

  22. UK, GitHub, AddThis, Wikia, Shazam, Wanelo, and Yammer.

  23. 

  24. Fastly is a San Francisco based company, located in the heart of SOMA.

  25. We are venture backed by Battery Ventures, OATV, August Capital, and Amplify

  26. Partners. We provide challenging work, opportunities to learn, high-quality

  27. teammates and, most importantly, we have a lot of fun doing what we love.

  28. We offer some great benefits like a Tahoe ski cabin, stocked fridge,

  29. flexible schedules, lots of company happy hours, and a no-vacation policy.

  30. We are close to MUNI and BART, and Caltrain is just a pleasant 15-minute stroll.

  31. 

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

  33. 

  34. 

  35. Module Features

  36. ---------------

  37. 

  38. 1. Account Sign In. If you are already an authenticated Fastly user,

  39. You can simply enter an API token and a list of service will show up in a

  40. drop down.

  41. 

  42. 2. Automated Purging. Content will be automatically purged when updated/created.

  43. This is done using Drupal 8's CacheTagsInvalidatorInterface.

  44. 

  45. How To Install The Module?

  46. --------------------------

  47. 

  48. 1. Install Fastly (unpacking it to your Drupal

  49. /modules directory if you're installing by hand, for example).

  50. 

  51. 2. Fastly will appear in your Configuration > Web services menu section.

  52. 

  53. 3. Enter your Fastly API token in the settings form and then select your service.

  54. 

  55. 4. *IMPORTANT* Make sure you click Upload Fastly VCL snippets. Although this step is not

  56. required it improves caching and enables features such as serve stale on errors etc.

  57. 

  58. If you find a problem, incorrect comment, obsolete or improper code or such,

  59. please search for an issue about it at http://drupal.org/project/fastly/issues

  60. If there isn't already an issue for it, please create a new one.

  61. 

  62. TLS and Fastly

  63. --------------

  64. Fastly can support TLS connections.

  65. See https://docs.fastly.com/guides/securing-communications for a list showing

  66. different options available. If you are using TLS, you should add the following

  67. lines of code to your settings.php

  68. 

  69. // Enable Fastly TLS connections.

  70. if (!empty($_SERVER['HTTP_FASTLY_SSL'])) {

  71.   $_SERVER['HTTPS'] = 'on';

  72. }

  73. 

  74. FASTLY API TOKEN

  75. ________________

  76. You can change it in settings form or you can use environment variable FASTLY_API_TOKEN to set it also.

  77. 

  78. FASTLY SERVICE ID

  79. _________________

  80. A Service represents the configuration for your website to be served through Fastly. You can override this with

  81. FASTLY_API_SERVICE environment variable

  82. 

  83. FASTLY SITE ID

  84. ______________

  85. Site identifier which is being prepended to cache tags. You can change it in settings form. Use this if you have

  86. multiple sites in the same service in Fastly. Note: You can use the environment variable FASTLY_SITE_ID

  87. to set this also. If nothing is set in either config or environment variable then one will be randomly generated for

  88. you.

  89. 

  90. FASTLY CACHE TAG HASH LENGTH

  91. ____________________________

  92. 

  93. For sites with more content, it may be necessary to increase the length of the hashed cache tags that are used for the

  94. Surrogate-Key header and when purging content. You can change it in settings form.

  95. This is due to hash collisions (https://en.wikipedia.org/wiki/Hash_table#Collision_resolution) which will result in

  96. excessive purging of content if the key length is too short.

  97. Note that this number should not be as large as the total number of cache tags in your site, just high enough to

  98. avoid most collisions during purging. Also you can override this with environment variable FASTLY_CACHE_TAG_HASH_LENGTH.