aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAnthony Ramine <[email protected]>2011-05-16 11:36:28 +0200
committerAnthony Ramine <[email protected]>2011-05-16 11:39:03 +0200
commit4e09d776f5368f432971429f9868052f55151555 (patch)
tree3c61d2228dc7582da728a72ee190a72a700877a0
parent0ca8f1364b857632030dbc3735ce789686361073 (diff)
downloadcowboy-4e09d776f5368f432971429f9868052f55151555.tar.gz
cowboy-4e09d776f5368f432971429f9868052f55151555.tar.bz2
cowboy-4e09d776f5368f432971429f9868052f55151555.zip
Document the path info feature
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5c7df2d..133af3b 100644
--- a/README.md
+++ b/README.md
@@ -124,6 +124,16 @@ you accept anything in that position. For example if you have both
"dev-extend.eu" and "dev-extend.fr" domains, you can use the match spec
`[<<"dev-extend">>, '_']` to match any top level extension.
+Finally, you can also match multiple leading segments of the domain name and
+multiple trailing segments of the request path using the atom `'...'` (the atom
+ellipsis) respectively as the first host token or the last path token. For
+example, host rule `['...', <<"dev-extend">>, <<"eu">>]` can match both
+"cowboy.bugs.dev-extend.eu" and "dev-extend.eu" and path rule
+`[<<"projects">>, '...']` can math both "/projects" and
+"/projects/cowboy/issues/42". The host leading segments and the path trailing
+segments can later be retrieved through `cowboy_http_req:host_info/1` and
+`cowboy_http_req:path_info/1`.
+
Any other atom used as a token will bind the value to this atom when
matching. To follow on our hostnames example, `[<<"dev-extend">>, ext]`
would bind the values `<<"eu">>` and `<<"fr">>` to the ext atom, that you