aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatt Rude <[email protected]>2011-06-22 10:17:40 -0500
committerMatt Rude <[email protected]>2011-06-22 10:17:40 -0500
commit6bea6f6c98bccae8e006d4cf17f55dadc2592a26 (patch)
treeb68a0e5389c2cf01fb214d1ef2e23bf1f7b56168 /README.md
parent8ad1aeca76af5838425dd4c5591d25e5e2d78f68 (diff)
downloadtime.mattrude.com-6bea6f6c98bccae8e006d4cf17f55dadc2592a26.tar.gz
time.mattrude.com-6bea6f6c98bccae8e006d4cf17f55dadc2592a26.tar.bz2
time.mattrude.com-6bea6f6c98bccae8e006d4cf17f55dadc2592a26.zip
Updated README file
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 29b9a3b..a0f5918 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,23 @@
This is my timeservers web site's source repository. This repository doesn't contain the code for NTP, but instead the code to run the actual website.
+## About ##
+
This site uses rrdtools to build and display usage graphs. rrdtools is required to be installed on the host server before the graphs may be created.
There is also a decent amount of back end setup that needs to happen before the graphs may be displayed, please see the README in the scripts directory for those instructions.
## Installing ##
+The install proccess for this project at this time is a bit cumbersome. Currently it assumes all files are stored in /var/www/time.mattrude.com. This will change in the future, but for now, it will be just easiest to create that director on your system.
+
+To install, first you need to add a cron entry for the RRD graphs.
+
+ */5 * * * * /var/www/time.mattrude.com/scripts/do-xntp > /dev/null 2&>1
+
+After adding the cron job, you may add your NTP Servers. To add your NTP servers, start by going into the scripts directory. Once in the scripts directory, run the do-newntpstat followed by the name of the computer, similar to below.
+ ./do-newntpstat time.example.com
+
### Rebuilding CSS ###
To Rebuild the css file, first download and install the [YUI Compressor](https://github.com/yui/yuicompressor), then run: