| Tyler Scott | 0826385 | 2015-07-31 19:05:52 -0600 | [diff] [blame] | 1 | NDN Catalog (NDN Query and Retrieval Tool) |
| 2 | ========================================== |
| 3 | |
| 4 | This is the front end to the catalog which contains all of the client html and code. |
| 5 | |
| 6 | Setup |
| 7 | ----- |
| 8 | |
| Tyler Scott | 8546aff | 2015-10-16 17:06:58 -0600 | [diff] [blame^] | 9 | To setup the site including the production folder simply run `./autogen.sh` |
| Tyler Scott | b59e6de | 2015-09-18 14:46:30 -0600 | [diff] [blame] | 10 | |
| 11 | The site will now be available in the catalog directory. |
| 12 | |
| 13 | If you run into issues of requiring sudo access you may need to [configure the npm prefix](http://competa.com/blog/2014/12/how-to-run-npm-without-sudo/) to point your global package repo somewhere else. Should you find yourself in a situation that you don't mind using sudo, feel free to simply just run with sudo. |
| 14 | |
| 15 | ##Serving the site: |
| 16 | |
| 17 | To serve the site, point a webserver at the same directory this README file is in. Then give users the url: http://<your domain>/catalog or /catalog-dev depending on if you are running deployment code. |
| 18 | |
| 19 | HTTPS is not supported and will break the code as it is unless the ndn backend is running a valid certificate as well, this is due to a security rule in most browsers that restricts the ws protocol from running in https tabs/frames. All content in the https frame MUST be secure. (Aka run wss in https) (HTTPS is not officially supported) |
| Tyler Scott | 0826385 | 2015-07-31 19:05:52 -0600 | [diff] [blame] | 20 | |
| Tyler Scott | 9eb6abd | 2015-08-04 14:48:23 -0600 | [diff] [blame] | 21 | config.json |
| 22 | ----------- |
| 23 | |
| Tyler Scott | b59e6de | 2015-09-18 14:46:30 -0600 | [diff] [blame] | 24 | ###Global |
| 25 | * CatalogPrefix - Where should the catalog attach in the URI scheme? (Usually the root of a catalog) |
| 26 | * FaceConfig - A valid NDN node location running the websocket for NDN-JS. |
| Tyler Scott | 9eb6abd | 2015-08-04 14:48:23 -0600 | [diff] [blame] | 27 | |
| Tyler Scott | b59e6de | 2015-09-18 14:46:30 -0600 | [diff] [blame] | 28 | ###Retrieval |
| 29 | * DemoKey - The public and private portion of an RSA in Base64. This key must be valid in the NDN Network for it to work. |
| 30 | * Destinations - A list of retrieval URIs. These must be running the retrieval code or retrieval will fail. |
| Tyler Scott | 9eb6abd | 2015-08-04 14:48:23 -0600 | [diff] [blame] | 31 | |
| 32 | Changing the theme |
| 33 | ------------------ |
| 34 | |
| 35 | Currently the theme is a modified bootstrap theme that is running larger fonts and custom colors. |
| 36 | |
| 37 | If you would like to modify the theme go to [this url](http://bootstrap-live-customizer.com/). To modify the current theme, then upload the variables.less in this folder, make your modifications, and overwrite the variables.less file when you are done (and the theme.min.css). |
| 38 | |
| 39 | |