Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Adding some notes about securing the site

  • Loading branch information...
commit fbcda68db0351ff7f27acd3f8c5fa21b3ca4d6bc 1 parent 359b52a
@qrush qrush authored
Showing with 20 additions and 0 deletions.
  1. +20 −0 README.textile
View
20 README.textile
@@ -12,6 +12,7 @@ h2. Requirements
* integrity installed
* metric_fu
* tinder
+* your favorite webserver
h2. Usage
@@ -19,6 +20,25 @@ Run: @rake grade@
Note: It's probably best to do this on a cron job.
+If you're running private projects, make sure to configure your webserver to block
+others from looking at your results. If you're using Apache to host your report_card
+site, here's what your VirtualHost could look like:
+
+<pre>
+<VirtualHost *:80>
+ ServerName metrics.thoughtbot.com
+ DocumentRoot /home/ci/report_card/_site
+
+ <DirectoryMatch /home\/ci\/report_card\/_site\/(archive|private|scores)>
+ AuthName "Metrics"
+ AuthUserFile /home/ci/.htpasswd
+ AuthGroupFile /dev/null
+ AuthType basic
+ require valid-user
+ </DirectoryMatch>
+</VirtualHost>
+</pre>
+
h2. Setup
Have a @config.yml@ file in your report_card directory with the following info:
Please sign in to comment.
Something went wrong with that request. Please try again.