updated readme
Costa Tsaousis (ktsaou) committed
Sep 22, 2015 at 02:14 UTC
b803b3e0099ef783526377ce11e39dd833450e94
1 file changed
+9
-7
README.md
+9
-7
@@ -97,7 +97,8 @@ Here is a screenshot:
97
- netdata is a web server, supporting gzip compression
98
99
It serves its own static files and dynamic files for rendering the site.
100
- (it does not support authentication or SSL - limit its access using your firewall)
100
+ It does not support authentication or SSL - limit its access using your firewall.
101
+ It does not allow ` .. ` or ` / ` in the files requested (so it can only serve files stored in the `web/` directory).
102
103
104
# How it works
@@ -107,10 +108,12 @@ Here is a screenshot:
108
109
netdata:
110
110
- - reads several /proc files
111
- - keeps track of the values in memroy (a short history)
112
- - generates JSON and JSONP HTTP responses containing all the data needed for the web graphs
113
- - is a web server. You can access JSON data by using:
111
+ - Spawns threads to collect all the data for all sources
112
+ - Keeps track of the collected values in memory (no disk I/O at all)
113
+ - Generates JSON and JSONP HTTP responses containing all the data needed for the web graphs
114
+ - Is a standalone web server.
115
+
116
+ For example, you can access JSON data by using:
117
118
```
119
http://127.0.0.1:19999/data/net.eth0
@@ -131,8 +134,7 @@ Here is a screenshot:
134
- 0/0 they are `before` and `after` timestamps, allowing panning on the data
135
136
134
-2. On your web page, you add a few javascript lines and a DIV for every graph you need.
135
- Your browser will hit the web server to fetch the JSON data and refresh the graphs.
137
+2. If you need to embed a **netdata** chart on your web page, you can add a few javascript lines and a `div` for every graph you need. Check [this example](http://195.97.5.206:19999/datasource.html) (open it in a new tab and view its source to get the idea).
138
139
3. Graphs are generated using Google Charts API (so, your client needs to have internet access).
140