diff --git a/README-UI.md b/README-UI.md index 1d1c480e..744fff78 100644 --- a/README-UI.md +++ b/README-UI.md @@ -1,36 +1,3 @@ # User interface files -There is [information for translators](http://www.pool.ntp.org/en/translators.html) -on the website. If you are looking to translate to a new language or update a translation, -look there first. - -## HTML Templates - -We use [template toolkit](http://www.template-toolkit.org) to template -the server generated html. For the www site the templates are in -`docs/ntppool`, the manage site files are in `docs/manage` and files -used across both are in `docs/shared`. - -Under any of these paths there's a `tpl/` directory for "internal -resources" (files that are included from user visible files). - -The "layout template" is in `docs/shared/tpl/style/default.html`. - -## CSS - -The CSS files for both the www and the manage site are in -`docs/shared/static/css`. They are currently shared across both sites. - -In production some files get concatenated and served as one according -to the configuration in `docs/shared/static/.static.groups.json`. - -## Javascript - -Similar to the CSS files the javascript files are in -`docs/shared/static/js`. - -## Issue tracker - -The [issue tracker](https://github.com/abh/ntppool/issues) for the -project is the best place to report issues (and find things that need -improvement). +See https://dev.ntppool.org/ui/ diff --git a/README.md b/README.md index f8b50ecd..c63156e6 100644 --- a/README.md +++ b/README.md @@ -4,103 +4,7 @@ This is the code for the NTP Pool project, http://www.pool.ntp.org/ See the LICENSE file for detailed copyright and licensing information. -# Installation instructions - -Quick and dirty install instructions; email ask@develooper.com for -help. - -```sh -export DIR=`pwd`/ntppool -git clone http://github.com/abh/ntppool -cd ntppool -git submodule update --init - -``` - -## Development under Docker - -If you have [Docker](http://docker.io/) -[installed](https://docs.docker.com/installation/) you can run a -container with most of the dependencies already ready with - - cp combust.docker.conf.sample combust.docker.conf - ./docker/app - -(Edit hostnames and database config in the new file after copying it.) - -The docker container will "export" the web application to port 8299 -on the docker host. If you are running Docker on OS X or Windows it -will be running in a virtual machine so the IP will be different -than "localhost". - -You can also run the other utilities, generally with a variation of - - ./docker/app sh ./pool zone - -This for example would generate the json DNS data for the GeoDNS server. - -## Non-Docker install - -The easiest way to install Perl 5.16.x (if your system didn't come -with this) is to use [perlbrew](http://perlbrew.pl): - -```sh -curl -kL http://install.perlbrew.pl | bash -perlbrew install perl-5.16.1 -perlbrew use perl-5.16.1 - -# Other dependencies -sudo port install libgeoip - -# install a bazillion modules from CPAN, use -n to not test each module, -# this will take a while. -mkdir cpan -cpanm -L cpan < .modules -``` - -Setup the configuration file: - -```sh -cp combust/combust.conf.sample combust.conf -edit combust.conf - # setup the database section with an "ntppool" database - # add "ntppool" to the "sites = ... " list. - # setup a [ntppool] section at the bottom -``` - -Configure mysql and the initial tables: - -```sh -# Your MySQL server needs timezone data loaded, if it doesn't have it, run: -mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql -mysqladmin -uroot create ntppool - -$CBROOT/bin/cmysql ntppool < sql/tables.sql -$CBROOT/bin/cmysql ntppool < sql/zones.sql -$CBROOT/bin/database_update ntppool -$CBROOT/bin/database_update combust -$CBROOT/bin/database_update ntppool -``` - -Start the web server: - -```sh -export CBROOTLOCAL=$DIR -export CBROOT=$DIR/combust - -make templates - -$CBROOT/bin/httpd -``` - -## Monitoring system - -To setup a monitoring system in the 'monitors' table, run - - `./pool addmonitor email@example.com 127.0.0.1 v4` - -It will return an api key to be used with the ./monitor script. - +For installation instructions, see https://dev.ntppool.org/install/ ## License