Nginx module to lookup Couchbase documents and register their top-level JSON keys as configuration variables.
Add as a static module:
cd <path to nginx sources>
./configure (...) --add-module=/path/to/nginx-couchlookup-module
make
As a dynamic module: see official documentation.
This is how to install Nginx 1.12.1 with PCRE 8.41 on OSX for development purposes:
- Module dependency:
brew install libcouchbase wget https://ftp.pcre.org/pub/pcre/pcre-8.41.tar.gz && tar -xvf pcre-8.41.tar.gzwget http://nginx.org/download/nginx-1.12.1.tar.gz && tar -xvf nginx-1.12.1.tar.gzcd nginx-1.12.1./configure --add-dynamic-module=../nginx-couchlookup-module --with-pcre=../pcre-8.41make- In Nginx conf:
load_module ngx_http_couchlookup_module.so;
When updating the module, run the following:
- (Re)build module:
make modules(fromnginx-1.12.1directory) - Copy dynamic library:
cp objs/ngx_http_couchlookup_module.so /usr/local/nginx - Start locally-built Nginx:
./objs/nginx -g "daemon off;"
Located in /etc/couch_creds.conf
localhost:testbucket:username:password
Prefix: doc_
Document 1: doc_123
{
"type": "redirect",
"url": "https://www.aquto.com/"
}
Document 2: doc_456
{
"type": "proxy",
"url": "https://www.wikipedia.org/"
}
server {
listen 80;
location ~ /lookup/(.*)$ {
resolver 8.8.8.8; # For proxy_pass when using a variable
couchlookup_creds /etc/couch_creds.conf;
couchlookup_read_doc "doc_$1" "type,url"; # -> $cl_type, $cl_url
# Logic branching
if ($cl_type = "redirect") {
return 307 $cl_url;
}
if ($cl_type = "proxy") {
proxy_pass $cl_url;
break; # Needed to avoid 404
}
return 404;
}
}
Document 1:
$ curl -v localhost/123
* Trying 127.0.0.1...
* Connected to localhost (127.0.0.1) port 80 (#0)
> GET /123 HTTP/1.1
> Host: localhost
> User-Agent: curl/7.43.0
> Accept: */*
>
< HTTP/1.1 307 Temporary Redirect
< Server: nginx/1.12.1
< Date: Tue, 15 Feb 2018 15:28:13 GMT
< Content-Type: text/html
< Content-Length: 187
< Connection: keep-alive
< Location: https://www.aquto.com/
<
...
Document 2:
$ curl -v localhost/456
* Trying 127.0.0.1...
* Connected to localhost (127.0.0.1) port 80 (#0)
> GET /123 HTTP/1.1
> Host: localhost
> User-Agent: curl/7.43.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Server: nginx/1.12.1
< Date: Thu, 15 Feb 2018 22:35:10 GMT
< Content-Type: text/html
< Content-Length: 187
< Connection: keep-alive
<
<!DOCTYPE html>
<html lang="mul" class="no-js">
<head>
<meta charset="utf-8">
<title>Wikipedia</title>
...
- jsmn: a copy of the source is shipped with this project in the
libdirectory - libcouchbase: referenced at compilation using the
-lcouchbaseflag