aboutsummaryrefslogtreecommitdiffstats
path: root/examples/ssl_hello_world/README.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-01-14 20:00:50 +0100
committerLoïc Hoguin <[email protected]>2016-01-14 20:00:50 +0100
commit394b4f0bf7f2a4d496ffe69c8e30cff153d69532 (patch)
tree82c3d7634f93596ec42b41050b4130805a359359 /examples/ssl_hello_world/README.asciidoc
parent4023e7f4e429179fd9c2cce4487c33646c6bd327 (diff)
downloadcowboy-394b4f0bf7f2a4d496ffe69c8e30cff153d69532.tar.gz
cowboy-394b4f0bf7f2a4d496ffe69c8e30cff153d69532.tar.bz2
cowboy-394b4f0bf7f2a4d496ffe69c8e30cff153d69532.zip
Simplify example instructions and fix broken examples
Also convert to AsciiDoc while we're at it.
Diffstat (limited to 'examples/ssl_hello_world/README.asciidoc')
-rw-r--r--examples/ssl_hello_world/README.asciidoc27
1 files changed, 27 insertions, 0 deletions
diff --git a/examples/ssl_hello_world/README.asciidoc b/examples/ssl_hello_world/README.asciidoc
new file mode 100644
index 0000000..d3fcf77
--- /dev/null
+++ b/examples/ssl_hello_world/README.asciidoc
@@ -0,0 +1,27 @@
+= Hello world example
+
+To try this example, you need GNU `make` and `git` in your PATH.
+
+To build and run the example, use the following command:
+
+[source,bash]
+$ make run
+
+Then point your browser to https://localhost:8443
+
+You will need to temporarily trust the root certificate authority,
+which can also be found in `priv/ssl/cowboy-ca.crt`.
+
+== Example output
+
+[source,bash]
+----
+$ curl --cacert priv/ssl/cowboy-ca.crt -i https://localhost:8443
+HTTP/1.1 200 OK
+connection: keep-alive
+server: Cowboy
+date: Fri, 28 Sep 2012 04:10:25 GMT
+content-length: 12
+
+Hello world!
+----