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

Page formatting

Browse Source
This commit is contained in:
Craine Runton 2016-08-04 16:00:24 -06:00
parent 885abc7f0f
commit c38bd9f8b1
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,5 +1,5 @@
# tls-dashboard
A dashboard written in JavaScript & HTML to check the remaining time before a TLS certificate expires. A combination of a Node module and an HTML/CSS/JS webpage to display the info.
A dashboard written in JavaScript & HTML to check the remaining time before a TLS certificate expires. A combination of a Node module and an HTML/CSS/JS webpage to display the info.
![version](https://img.shields.io/badge/version-1.2.0-brightgreen.svg?style=flat-square)
@ -22,17 +22,17 @@ This module performs the actual HTTPS connection and evaluation of the peer cert
1. Run the script manually whenever you need to update your dashboard by calling `node get_cert_info.js`; or
2. Set up the script to run on a cronjob
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
### 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.
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 (recommended if you're using Git to deploy) 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 the `web_service` directory, and the links are relative links, there's nothing else you need to change.
## 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.
![Example dashboard](https://raw.githubusercontent.com/cmrunton/tls-dashboard/master/tls-dashboard.png)
@ -49,4 +49,4 @@ The node module has no dependencies external to the node core. The following dep
* Handlebars v4.0.5
* Bootstrap v4.0.0-alpha (CSS only)
[1]:https://pages.runtondev.com/tls-dashboard/demo/
[1]:https://pages.runtondev.com/tls-dashboard/demo/