aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoradamw <adam@warski.org>2017-09-22 16:26:56 +0200
committeradamw <adam@warski.org>2017-09-22 16:26:56 +0200
commit77dfc7bfa577ab72d2325efcad813f6a165a4c36 (patch)
treec387a9fdb268172939620230e0f75e96f4a893d6 /README.md
parent70b859bc8fe67dd9234109fe5176c0f9ead564bb (diff)
downloadsttp-77dfc7bfa577ab72d2325efcad813f6a165a4c36.tar.gz
sttp-77dfc7bfa577ab72d2325efcad813f6a165a4c36.tar.bz2
sttp-77dfc7bfa577ab72d2325efcad813f6a165a4c36.zip
#11, #35: SSL docs, more options for customizing delegated client calls
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 725f758..c12b4e7 100644
--- a/README.md
+++ b/README.md
@@ -498,6 +498,22 @@ sttp
.send()
```
+## SSL
+
+SSL handling can be customized (or disabled) when creating a backend and is
+backend-specific.
+
+Depending on the underlying backend's client, you can customize SSL settings
+as follows:
+
+* `HttpUrlConnectionBackend`: when creating the backend, specify the `customizeConnection: HttpURLConnection => Unit`
+parameter, and set the hostname verifier & SSL socket factory as required
+* akka-http: when creating the backend, specify the `customHttpsContext: Option[HttpsConnectionContext]`
+parameter. See [akka-http docs](http://doc.akka.io/docs/akka-http/current/scala/http/server-side/server-https-support.html)
+* async-http-client: create a custom client and use the `setSSLContext` method
+* OkHttp: create a custom client modifying the SSL settings as described
+[on the wiki](https://github.com/square/okhttp/wiki/HTTPS)
+
## Notes
* the encoding for `String`s defaults to `utf-8`.