mirror of
https://github.com/inspec/inspec
synced 2024-12-11 22:02:47 +00:00
d022faea81
inspec.io is now hosted by Fastly which operates as a caching reverse proxy. This change adds a Rake task that will flush the cache at Fastly if the API key and Service ID are set in the appropriate environment variables. Flushing the cache is not required, so this will not error out if the environment variables aren't provided; the cache will eventually clear on its own. This will simply speed along the process as needed. Signed-off-by: Adam Leff <adam@leff.co>
62 lines
1.4 KiB
Markdown
62 lines
1.4 KiB
Markdown
# InSpec homepage
|
|
|
|
## Development
|
|
|
|
Get all dependencies:
|
|
|
|
```bash
|
|
bundle install
|
|
```
|
|
|
|
To run it live run:
|
|
|
|
```bash
|
|
bundle exec middleman server
|
|
```
|
|
|
|
For the online tutorial, take a look at `www/tutorial`.
|
|
|
|
## Building
|
|
|
|
To build the site to a local static folder (without tutorial):
|
|
|
|
```bash
|
|
bundle exec middleman build
|
|
```
|
|
|
|
To build everything including the online tutorial:
|
|
|
|
```
|
|
bundle exec rake www:build
|
|
```
|
|
|
|
## Releasing
|
|
|
|
To build everything and push a new version of the website, be in the www folder of this repository and run:
|
|
|
|
```
|
|
bundle install
|
|
bundle exec rake www
|
|
```
|
|
|
|
It will clear everything and build from scratch and create a local `gh-pages` branch with a static version of the website.
|
|
Before pushing, it will ask you if you are happy with it.
|
|
|
|
**Please verify the site now!** To host the current folder you can run:
|
|
|
|
```
|
|
ruby -run -e httpd . -p 8000
|
|
```
|
|
|
|
Open your browser to [localhost:8000](http://localhost:8000).
|
|
|
|
If you are happy, you can confirm the site and let the release task push it live.
|
|
|
|
### Flushing the Fastly Cache
|
|
|
|
The `www` Rake task will flush the cache at Fastly if you have the following environment variables set:
|
|
|
|
* `FASTLY_API_KEY`
|
|
* `FASTLY_SERVICE_ID`
|
|
|
|
These can be found in Chef's shared password manager. If these aren't set, the cache will not be flushed and will expire on its own. The cache can be flushed without doing a full website release by running `rake www:flush`
|