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

further readme improvements

parent 6cc0f40e
......@@ -2,21 +2,20 @@
Welcome to the jCoAP Proxy
This implementation provides a forward proxy between CoAP and HTTP.
I supports:
This implementation provides a forward proxy between CoAP and HTTP, supporting:
* HTTP to CoAP translation and caching
* CoAP to HTTP translation and caching and
* CoAP to CoAP caching
As forward proxy the client needs to be aware of the proxy:
As forward proxy the client needs to be aware of the proxy and therfor needs to interact directly with the proxy.
The HTTP to CoAP Proxy functionality is used by a protocol-agnostic access.
This means, that the HTTP client is not aware of translation to CoAP.
This means, that the HTTP client is not aware of the translation to CoAP.
The URI specified in the HTTP request is assumed as URI to the CoAP server that will be acessed by the CoAP client of the Proxy.
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).
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.
```
```text
+-----------------------------------------------+
| jCoAP Proxy |
| |
......@@ -26,14 +25,15 @@ 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.
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.
```
```text
Notice that https:// and coaps:// are not supported as security is not implemented yet.
```
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)
```
```text
+-----------------------------------------------+
| jCoAP Proxy |
| |
......@@ -53,7 +53,7 @@ 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[PDF](http://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
```
......@@ -108,11 +108,11 @@ In IntelliJ, choose *[File.. » Open]* then select the location of the clon
IntelliJ will then automatically import all projects and resolve required Maven dependencies.
# License
jCoAP is licensed under [Apache License, Version 2.0](./license.txt) see `license.txt`
jCoAP is licensed under Apache License, Version 2.0 see [`license.txt`](./license.txt)
# Third Party Software
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)
* ehcache
* httpasyncclient
* commons-cli
\ No newline at end of file
* [ehcache](http://www.ehcache.org/) - [Apache License - v 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
* [httpasyncclient](https://hc.apache.org/httpcomponents-asyncclient-dev/) - [Apache License - v 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
* [commons-cli](http://commons.apache.org/proper/commons-cli/) - [Apache License - v 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
\ 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