configuration.rst 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. .. _gwc_s3_configuration:
  2. Configuring the S3 BlobStore plugin
  3. ===================================
  4. Once the plugin has been installed, one or more S3 BlobStores may be configured through :ref:`gwc_webadmin_blobstores`.
  5. Afterwards, cached layers can be explicitly assigned to it or one blobstore could be marked as 'default' to use it for all unassigned layers.
  6. .. figure:: img/s3blobstore.png
  7. :align: center
  8. Bucket
  9. ~~~~~~
  10. The name of the AWS S3 bucket where the tiles are stored.
  11. AWS Access Key
  12. ~~~~~~~~~~~~~~
  13. The AWS Access Key ID.
  14. If AWS Access Key and AWS Secret Access Key are left blank, `AWS Default Credential Chain <https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html>`_ will be used.
  15. AWS Secret Key
  16. ~~~~~~~~~~~~~~
  17. AWS Secret Access Key.
  18. S3 Object Key Prefix
  19. ~~~~~~~~~~~~~~~~~~~~~
  20. A prefix path to use as the root to store tiles under the bucket (optional).
  21. Maximum Connections
  22. ~~~~~~~~~~~~~~~~~~~
  23. The maximum number of allowed open HTTP connections.
  24. Use HTTPS
  25. ~~~~~~~~~
  26. When enabled, a HTTPS connection will be used. When disabled, a regular HTTP connection will be used.
  27. Proxy Domain
  28. ~~~~~~~~~~~~
  29. A Windows domain name for configuring NTLM proxy support (optional).
  30. Proxy Workstation
  31. ~~~~~~~~~~~~~~~~~
  32. A Windows workstation name for configuring NTLM proxy support (optional).
  33. Proxy Host
  34. ~~~~~~~~~~
  35. Proxy host the client will connect through (optional).
  36. Proxy Port
  37. ~~~~~~~~~~
  38. Proxy port the client will connect through (optional).
  39. Proxy Username
  40. ~~~~~~~~~~~~~~
  41. User name the client will use if connecting through a proxy (optional).
  42. Proxy Password
  43. ~~~~~~~~~~~~~~
  44. Password the client will use if connecting through a proxy (optional).
  45. Use Gzip
  46. ~~~~~~~~
  47. When enabled, the stored tiles will be GZIP compressed.
  48. Access Type
  49. ~~~~~~~~~~~
  50. Stored tiles will be created either as Public (readable and writable by any user that can access the S3 bucket), or Private
  51. (readable and writable only by the user identified by the AWS credentials specified above).
  52. **Important**: if the bucket itself is setup to block all public access, then the blobstore needs to be setup to Private as well, or AWS will return a 403 when attempting to store tiles.