Skip to content

Latest commit

 

History

History
121 lines (111 loc) · 3.48 KB

README.md

File metadata and controls

121 lines (111 loc) · 3.48 KB
Raw

Xonacatl Cookbook

This cookbook sets up Xonacatl, the "layers" server.

Requirements

recipes

  • apt
  • golang
  • runit
  • user

Attributes

xonacatl::default

Key Type Description Default
['xonacatl']['package'] String Package to install github.com/tilezen/xonacatl/xonacatl_server
['xonacatl']['cfg_file'] String Config file name xonacatl.conf
['xonacatl']['cfg_path'] String Config file location /etc/xonacatl
['xonacatl']['pattern'] String URL pattern to use for matching requests. Anything which doesn't match will return a 404. The Gorilla Mux syntax for URL patterns is used, and you may use any captures you like. The pattern captures *must* include `layers` and `fmt`. /{layers}/{z:[0-9]+}/{x:[0-9]+}/{y:[0-9]+}.{fmt}
['xonacatl']['host'] String Upstream URL pattern to use for fetching tiles. Note that the default value is not valid, and should be replaced with whatever you want. The interpolation variables available are those used in the pattern. http://upstream.tile.server/{layers}/{z:[0-9]+}/{x:[0-9]+}/{y:[0-9]+}.{fmt}
['xonacatl']['listen'] String The `interface:port` to listen on. :80
['xonacatl']['headers'] Array of String Optional. Any extra headers to add when making requests to the origin. []
['xonacatl']['healthcheck'] String Optional. If present, then the path to respond to healthchecks on. nil
['xonacatl']['runit']['timeout'] Integer The time in seconds runit should wait to see if a service starts up successfully. 60
['xonacatl']['user']['create_group'] Boolean Whether to create a group for the user. true
['xonacatl']['user']['enabled'] Boolean Whether to create a user for xonacatl. true
['xonacatl']['user']['home'] String The user's home directory location. /home/xonacatl
['xonacatl']['user']['user'] String The user's name. xonacatl

Contributing

We welcome contributions to xonacatl's Chef recipe. To contribute, please use the standard Github workflow:

  1. Fork the repository on Github
  2. Create a named feature branch (like add_component_x)
  3. Write your change
  4. Write tests for your change (if applicable)
  5. Run the tests, ensuring they all pass
  6. Submit a Pull Request using Github

License and Authors

Copyright Mapzen 2016. Available under the MIT license. See LICENSE for more information.