summaryrefslogtreecommitdiffstats
path: root/docs/en/gun/2.2/guide/start.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2025-04-11 14:34:51 +0200
committerLoïc Hoguin <[email protected]>2025-04-11 14:34:51 +0200
commiteb808a3f8bbd97d2a2ea0114b43b708a17b44066 (patch)
treefc142e5b11792af4f84d8634d9a8809f32344634 /docs/en/gun/2.2/guide/start.asciidoc
parent25e93c91878b7f8536764b06d2cb72020031acd1 (diff)
downloadninenines.eu-master.tar.gz
ninenines.eu-master.tar.bz2
ninenines.eu-master.zip
Gun 2.2.0HEADmaster
Diffstat (limited to 'docs/en/gun/2.2/guide/start.asciidoc')
-rw-r--r--docs/en/gun/2.2/guide/start.asciidoc43
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/en/gun/2.2/guide/start.asciidoc b/docs/en/gun/2.2/guide/start.asciidoc
new file mode 100644
index 00000000..09720dca
--- /dev/null
+++ b/docs/en/gun/2.2/guide/start.asciidoc
@@ -0,0 +1,43 @@
+[[start]]
+== Starting and stopping
+
+This chapter describes how to start and stop the Gun application.
+
+=== Setting up
+
+Specify Gun as a dependency to your application in your favorite
+build tool.
+
+With Erlang.mk this is done by adding `gun` to the `DEPS` variable
+in your Makefile.
+
+.Adding Gun as an Erlang.mk dependency
+[source,make]
+----
+DEPS = gun
+----
+
+=== Starting
+
+Gun is an _OTP application_. It needs to be started before you can
+use it.
+
+.Starting Gun in an Erlang shell
+[source,erlang]
+----
+1> application:ensure_all_started(gun).
+{ok,[crypto,cowlib,asn1,public_key,ssl,gun]}
+----
+
+=== Stopping
+
+You can stop Gun using the `application:stop/1` function, however
+only Gun will be stopped. This is the reverse of `application:start/1`.
+The `application_ensure_all_started/1` function has no equivalent for
+stopping all applications.
+
+.Stopping Gun
+[source,erlang]
+----
+application:stop(gun).
+----