Convert the SSL hello world example to a release

essen · Sep 8, 2013 · 24a22fa · 24a22fa
1 parent 1f8119e
commit 24a22fa
Show file tree

Hide file tree

Showing 9 changed files with 42 additions and 40 deletions.
diff --git a/examples/ssl_hello_world/Makefile b/examples/ssl_hello_world/Makefile
@@ -0,0 +1,14 @@
+PROJECT = ssl_hello_world
+
+DEPS = cowboy
+dep_cowboy = pkg://cowboy master
+
+.PHONY: release clean-release
+
+release: clean-release all
+	relx
+
+clean-release:
+	rm -rf _rel
+
+include ../../erlang.mk
diff --git a/examples/ssl_hello_world/README.md b/examples/ssl_hello_world/README.md
@@ -1,23 +1,27 @@
-Cowboy Hello World
-==================
+Hello world example
+===================
 
-To compile this example you need rebar in your PATH.
+To try this example, you need GNU `make`, `git` and
+[relx](https://github.com/erlware/relx) in your PATH.
 
-Type the following command:
-```
-$ rebar get-deps compile
-```
+To build the example, run the following command:
 
-You can then start the Erlang node with the following command:
+``` bash
+$ make
 ```
-./start.sh
+
+To start the release in the foreground:
+
+``` bash
+$ ./_rel/bin/ssl_hello_world_example console
 ```
 
-Then point your browser to the indicated URL. You will need to temporarily
-trust the root certificate authority in `priv/ssl/cowboy-ca.crt`.
+Then point your browser at [http://localhost:8443](http://localhost:8443).
+You will need to temporarily trust the root certificate authority,
+which can also be found in `priv/ssl/cowboy-ca.crt`.
 
-Example
--------
+Example output
+--------------
 
 ``` bash
 $ curl --cacert priv/ssl/cowboy-ca.crt -i https://localhost:8443

diff --git a/examples/ssl_hello_world/rebar.config b/examples/ssl_hello_world/rebar.config
diff --git a/examples/ssl_hello_world/relx.config b/examples/ssl_hello_world/relx.config
@@ -0,0 +1,2 @@
+{release, {ssl_hello_world_example, "1"}, [ssl_hello_world]}.
+{extended_start_script, true}.
diff --git a/examples/ssl_hello_world/src/ssl_hello_world.app.src b/examples/ssl_hello_world/src/ssl_hello_world.app.src
@@ -8,7 +8,8 @@
 	{applications, [
 		kernel,
 		stdlib,
-		cowboy
+		cowboy,
+		ssl
 	]},
 	{mod, {ssl_hello_world_app, []}},
 	{env, []}

diff --git a/examples/ssl_hello_world/src/ssl_hello_world.erl b/examples/ssl_hello_world/src/ssl_hello_world.erl
diff --git a/examples/ssl_hello_world/src/ssl_hello_world_app.erl b/examples/ssl_hello_world/src/ssl_hello_world_app.erl
@@ -16,11 +16,12 @@ start(_Type, _Args) ->
 			{"/", toppage_handler, []}
 		]}
 	]),
+	PrivDir = code:priv_dir(ssl_hello_world),
 	{ok, _} = cowboy:start_https(https, 100, [
 		{port, 8443},
-		{cacertfile, "priv/ssl/cowboy-ca.crt"},
-		{certfile, "priv/ssl/server.crt"},
-		{keyfile, "priv/ssl/server.key"}
+		{cacertfile, PrivDir ++ "/ssl/cowboy-ca.crt"},
+		{certfile, PrivDir ++ "/ssl/server.crt"},
+		{keyfile, PrivDir ++ "/ssl/server.key"}
 	], [{env, [{dispatch, Dispatch}]}]),
 	ssl_hello_world_sup:start_link().
 

diff --git a/examples/ssl_hello_world/src/toppage_handler.erl b/examples/ssl_hello_world/src/toppage_handler.erl
@@ -11,7 +11,9 @@ init(_Transport, Req, []) ->
 	{ok, Req, undefined}.
 
 handle(Req, State) ->
-	{ok, Req2} = cowboy_req:reply(200, [], <<"Hello world!">>, Req),
+	{ok, Req2} = cowboy_req:reply(200, [
+		{<<"content-type">>, <<"text/plain">>}
+	], <<"Hello world!">>, Req),
 	{ok, Req2, State}.
 
 terminate(_Reason, _Req, _State) ->

diff --git a/examples/ssl_hello_world/start.sh b/examples/ssl_hello_world/start.sh