| 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 | 1ffb3b1 | 2016-08-21 03:46:07 +0000 | [diff] [blame] | 9 | Simply run a webserver on THIS directory (aka |
| 10 | .../ndn-atmos/client) and point clients to /catalog on either the domain or |
| 11 | IP that the server is running on. |
| Tyler Scott | b59e6de | 2015-09-18 14:46:30 -0600 | [diff] [blame] | 12 | |
| Tyler Scott | 1ffb3b1 | 2016-08-21 03:46:07 +0000 | [diff] [blame] | 13 | Good suggestions are http-server in npm, pythons SimpleHTTPServer, or a standard |
| 14 | webserver like nginx or apache. |
| Tyler Scott | b59e6de | 2015-09-18 14:46:30 -0600 | [diff] [blame] | 15 | |
| Tyler Scott | 1ffb3b1 | 2016-08-21 03:46:07 +0000 | [diff] [blame] | 16 | __Note:__ |
| 17 | HTTPS is not supported unless the ndn websocket server is running a valid |
| 18 | certificate as well as the web server. This is due to a security rule in most |
| 19 | browsers that restricts the ws protocol from running in https tabs/frames. All |
| 20 | content in the https frame MUST be secure including the websocket. |
| 21 | (HTTPS is untested at this time but you can ask questions on the mailing list |
| 22 | if you have problems.) |
| Tyler Scott | 0826385 | 2015-07-31 19:05:52 -0600 | [diff] [blame] | 23 | |
| Tyler Scott | 9eb6abd | 2015-08-04 14:48:23 -0600 | [diff] [blame] | 24 | config.json |
| 25 | ----------- |
| 26 | |
| Tyler Scott | b59e6de | 2015-09-18 14:46:30 -0600 | [diff] [blame] | 27 | ###Global |
| Tyler Scott | 1ffb3b1 | 2016-08-21 03:46:07 +0000 | [diff] [blame] | 28 | * CatalogPrefix - Where should the catalog attach in the URI scheme? (Usually the |
| 29 | root of a catalog) |
| Tyler Scott | b59e6de | 2015-09-18 14:46:30 -0600 | [diff] [blame] | 30 | * FaceConfig - A valid NDN node location running the websocket for NDN-JS. |
| Tyler Scott | 9eb6abd | 2015-08-04 14:48:23 -0600 | [diff] [blame] | 31 | |
| Tyler Scott | b59e6de | 2015-09-18 14:46:30 -0600 | [diff] [blame] | 32 | ###Retrieval |
| Tyler Scott | 1ffb3b1 | 2016-08-21 03:46:07 +0000 | [diff] [blame] | 33 | * DemoKey - The public and private portion of an RSA in Base64. This key must be |
| 34 | valid in the NDN Network for it to work. |
| 35 | * Destinations - A list of retrieval URIs. These must be running the retrieval |
| 36 | code or retrieval will fail. |
| Tyler Scott | 9eb6abd | 2015-08-04 14:48:23 -0600 | [diff] [blame] | 37 | |
| 38 | Changing the theme |
| 39 | ------------------ |
| 40 | |
| Tyler Scott | 1ffb3b1 | 2016-08-21 03:46:07 +0000 | [diff] [blame] | 41 | Currently the theme is a modified bootstrap theme that is running larger fonts |
| 42 | and custom colors. |
| Tyler Scott | 9eb6abd | 2015-08-04 14:48:23 -0600 | [diff] [blame] | 43 | |
| Tyler Scott | 1ffb3b1 | 2016-08-21 03:46:07 +0000 | [diff] [blame] | 44 | If you would like to modify the theme go to [this url](http://bootstrap-live-customizer.com/). |
| 45 | To modify the current theme, then upload the variables.less in this folder, make |
| 46 | your modifications, and overwrite the variables.less file when you are done |
| 47 | (and the theme.min.css). |
| Tyler Scott | 9eb6abd | 2015-08-04 14:48:23 -0600 | [diff] [blame] | 48 | |
| 49 | |