Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Horace Ip authored and Horace Ip committed Oct 4, 2019
1 parent 488d227 commit 73155fd
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,23 @@

## Configuration


The configuration of the web viewer can be modified through a JSON. The JSON file is named `config.json` or specified by a parameter

`http://myhost.com/?config=./myconfig.json`.

The `myconfig.json` file should reside with the directory that contains `index.html`.

The `ncwebviewer-config` reads from the nanocube server and generates
`nanocube_webconfig` reads from the nanocube server and generates
a JSON con figuration file with all the tweakable parameters for the
widgets. Here are some handy examples.
widgets.

You may obtain the default config file from the chicago crime example by

```
nanocube_webconfig -s http://`hostname -f` --ncport 51234 > mycrimes.json
```

Here are some handy attributes.

* Colormap
* Number format
Expand All @@ -24,6 +31,20 @@ widgets. Here are some handy examples.
There is a `css` attribute for each widget, you may change the style
of the widget by modifying or inserting standard css elements.

You may test your configuration file by

```
nanocube_webconfig -s http://`hostname -f` --ncport 51234 --config mycrimes.json --port 8000
```

## Deployment

Please copy the content of the `dist` directory along with your customized configuration to your web hosting directory.


## SSL Web Server
The nanocubes backend server and the test server do not support SSL, we suggest you use a standard webserver such as `nginx` as your SSL entry point and redirect the traffic appropriately.


## Development

Expand Down

0 comments on commit 73155fd

Please sign in to comment.