History

Sean Kilgore edc31a9391 docs: clarify address specification for telemetry Earlier on this page, under `addresses`, we say "For TCP addresses, these should simply be an IP address without the port. For example: 10.0.0.1, not 10.0.0.1:8500." Since we expect the port to be included for `_address` for telemetry, call it out specifically.		2016-05-24 12:55:23 -07:00
..
scripts	Update website metadata fixes	2016-04-12 20:14:56 +01:00
source	docs: clarify address specification for telemetry	2016-05-24 12:55:23 -07:00
Gemfile	Remove Ruby requirement from Gemfile	2016-01-13 18:04:05 -05:00
Gemfile.lock	add announcement banner for Consul Enterprise launch	2016-03-03 12:23:30 -08:00
LICENSE.md	…
Makefile	Add makefile and update readme	2015-10-09 18:29:08 -04:00
README.md	Use HTTPS + www. where appropriate	2016-01-13 17:44:01 -05:00
Vagrantfile	website/Vagrantfile works again.	2015-08-06 17:39:48 -07:00
config.rb	Updates website to version 0.6.4.	2016-03-16 10:36:57 -07:00
config.ru	Use Rack::Protection	2015-07-13 12:56:46 -04:00
packer.json	Update website metadata fixes	2016-04-12 20:14:56 +01:00

README.md

Consul Website

This subdirectory contains the entire source for the Consul Website. This is a Middleman project, which builds a static site from these source files.

Contributions Welcome!

If you find a typo or you feel like you can improve the HTML, CSS, or JavaScript, we welcome contributions. Feel free to open issues or pull requests like any normal GitHub project, and we'll merge it in.

Running the Site Locally

Running the site locally is simple. Clone this repo and run make dev.

Then open up localhost:4567. Note that some URLs you may need to append ".html" to make them work (in the navigation and such).

Building Site

Building the static version of the site and running it is simple. Clone this repo and run the following commands:

$ bundle
$ bundle exec middleman build
$ foreman start

Then open up localhost:5000.

Alternately, the site can now be deployed to Heroku or Cloud Foundry.