Commit 6cc0f40e authored by Björn Butzin's avatar Björn Butzin
Browse files

improved readme

parent 29ff6733
......@@ -16,6 +16,7 @@ The URI specified in the HTTP request is assumed as URI to the CoAP server that
In order to send HTTP requests from a web-browser to the jCoAP proxy make sure to configure the proxy in your browsers settings.
The HTTP proxy server is started on Port 8080 (HTTP default port).
```
+-----------------------------------------------+
| jCoAP Proxy |
| |
......@@ -24,7 +25,7 @@ The HTTP proxy server is started on Port 8080 (HTTP default port).
+-------------+ +-------------+ +-------+ +-------------+ +-------------+
| |
+-----------------------------------------------+
```
As CoAP was designed with proxies in mind CoAP messages can contain a Proxy-URI option.
The Proxy-URI option is mandatory and should either start with 'http://' or 'coap://' to select the target protocol.
```
......@@ -32,7 +33,7 @@ Notice that https:// and coaps:// are not supported as security is not implement
```
As example the Proxy-URI 'http://127.0.0.1/wanted' will cause the proxy to fetch the 'wanted' resource using HTTP, while the Proxy-URI 'coap://127.0.0.1/wanted' will cause the proxy to fetch the 'wanted' resource using CoAP
The CoAP proxy server is started on port 5683 (CoAP default port)
```
+-----------------------------------------------+
| jCoAP Proxy |
| |
......@@ -45,14 +46,14 @@ The CoAP proxy server is started on port 5683 (CoAP default port)
| +-------+ +-------------+ +-------------+
| |
+-----------------------------------------------+
```
Aditionally the proxy starts a second CoAP server on port 5684 offering the '/statistic' resource.
A closer look on the proxy implementation can be foud in:
```
Christian Lerche, Nico Laum, Frank Golatowski, Christoph Niedermeier, Dirk Timmermann:
[Connecting the Web with the Web of Things: Lessons Learned From Implementing a CoAP-HTTP Proxy](https://www.amd.e-technik.uni-rostock.de/veroeff/2012_Connecting%20the%20Web%20with%20the%20Web%20of%20Things.pdf)
[Connecting the Web with the Web of Things: Lessons Learned From Implementing a CoAP-HTTP Proxy](https://www.amd.e-technik.uni-rostock.de/veroeff/2012_Connecting%20the%20Web%20with%20the%20Web%20of%20Things.pdf)
Proceedings of the IoTech Workshop 2012, Las Vegas, USA, Oktober 2012
```
......@@ -110,6 +111,8 @@ IntelliJ will then automatically import all projects and resolve required Maven
jCoAP is licensed under [Apache License, Version 2.0](./license.txt) see `license.txt`
# Third Party Software
jCoAP uses the folowing third party components
The jCoAP Proxy uses the folowing third party components
* [log4j](https://logging.apache.org/log4j/) - [Apache License - v 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
* [jUnit](http://junit.org) - [Eclipse Public License - v 1.0](https://www.eclipse.org/legal/epl-v10.html)
\ No newline at end of file
* ehcache
* httpasyncclient
* commons-cli
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment