diff options
| author | Loïc Hoguin <[email protected]> | 2016-11-25 01:03:21 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2016-11-25 01:03:21 +0100 |
| commit | 200653764049b4338be5768efaea8fe7c4448a5c (patch) | |
| tree | ebb1f39f60d4a1288c2e3b7bde4be7cee1708c10 /doc | |
| parent | f2cfd93a6673c10a0b1f74e588abeebb40f296de (diff) | |
| download | ranch-200653764049b4338be5768efaea8fe7c4448a5c.tar.gz ranch-200653764049b4338be5768efaea8fe7c4448a5c.tar.bz2 ranch-200653764049b4338be5768efaea8fe7c4448a5c.zip | |
Update docs about the dependency on ssl
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/src/guide/transports.asciidoc | 26 | ||||
| -rw-r--r-- | doc/src/manual/ranch_app.asciidoc | 11 |
2 files changed, 13 insertions, 24 deletions
diff --git a/doc/src/guide/transports.asciidoc b/doc/src/guide/transports.asciidoc index 9195376..f5bb17e 100644 --- a/doc/src/guide/transports.asciidoc +++ b/doc/src/guide/transports.asciidoc @@ -13,25 +13,17 @@ The TCP transport is a thin wrapper around `gen_tcp`. === SSL transport -The SSL transport is a thin wrapper around `ssl`. It requires -the `crypto`, `asn1`, `public_key` and `ssl` applications -to be started. When starting an SSL listener, Ranch will attempt -to automatically start them. It will not try to stop them when -the listener is removed, however. +The SSL transport is a thin wrapper around `ssl`. -.Starting the SSL application +Ranch depends on `ssl` by default so any necessary +dependencies will start when Ranch is started. It is +possible to remove the dependency when the SSL transport +will not be used. Refer to your release build tool's +documentation for more information. -[source,erlang] -ssl:start(). - -In a proper OTP setting, you will need to make your application -depend on the `crypto`, `public_key` and `ssl` applications. -They will be started automatically when starting your release. - -The SSL transport `accept/2` function performs both transport -and SSL accepts. Errors occurring during the SSL accept phase -are returned as `{error, {ssl_accept, atom()}}` to differentiate -on which socket the problem occurred. +When embedding Ranch listeners that have an SSL transport, +your application must depend on the `ssl` application for +proper behavior. === Sending and receiving data diff --git a/doc/src/manual/ranch_app.asciidoc b/doc/src/manual/ranch_app.asciidoc index 2edfc72..f5b6e00 100644 --- a/doc/src/manual/ranch_app.asciidoc +++ b/doc/src/manual/ranch_app.asciidoc @@ -6,13 +6,10 @@ ranch - Socket acceptor pool for TCP protocols. == Dependencies -The `ranch` application has no particular dependency required -to start. - -It has optional dependencies that are only required when -listening for SSL connections. The dependencies are `crypto`, -`asn1`, `public_key` and `ssl`. They are started automatically -if they weren't before. +The `ranch` application depends on the `ssl` application to +start. It is used for handling secure connections, when the +transport is `ranch_ssl`. It can be disabled if SSL is not +used. == Environment |