aboutsummaryrefslogtreecommitdiffstats
path: root/manual/ranch_app.md
blob: 380931c2ffd24748d8087d5dde505b2235e6e377 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
The Ranch Application
=====================

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.

Environment
-----------

The `ranch` application defines one application environment
configuration parameter.

 -  profile (false)
   -  When enabled, Ranch will start `etop` profiling automatically.

You can use the `ranch_app:profile_output/0` function to stop
profiling and output the results to the files `procs.profile`
and `total.profile`. Do not use in production.