jrd/tls-dashboard
1
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity

Update README to reflect testing on a local machine. Closes Issue #11

Browse Source
This commit is contained in:
Craine Runton 2016-06-08 15:02:13 -06:00
parent 613941cce3
commit 2bad1fa923
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -25,7 +25,11 @@ This module performs the actual HTTPS connection and evaluation of the peer cert
It's entirely up to you how you want to handle it. It's entirely up to you how you want to handle it.
## Web Service Setup ## Web Service Setup
To get the web service started, you'll need to either move the contents of the `web_service` directory to somewhere in your web site's path, or create a symlink from the web site path back to the directory. If you move the contents, please update the `output_file.path` config value. These are static files with relative links, so other than moving them/pointing the server to them, there's nothing else required for you to do. ### Development
If you're using this on a local machine, and you haven't made any changes to the default config, then once you've ran `node get_cert_info.js` as described above, all you have to do is open the `web_service/index.html` file in your browser of choice. All of the dependencies are there and the links are relative, so you should be good to go.
### Production
To get the web service started on a remote server, you'll need to either move the contents of the `web_service` directory to somewhere in your web site's path, or create a symlink from the web site path back to the directory. If you move the contents, please update the `output_file.path` config value. Again, since all of the Dashbaord's dependencies are in teh `web_service` directory, and the links are relative links, there's nothing else you need to change.
## Example ## Example
Take a look at a live example page [here on GitLab][1]. Screenshots below. Take a look at a live example page [here on GitLab][1]. Screenshots below.