Skip to content

Latest commit

 

History

History
44 lines (36 loc) · 1.54 KB

README.md

File metadata and controls

44 lines (36 loc) · 1.54 KB
Raw

pagekite-letsencrypt

Server that helps the Box to announce its local IP address without relying on mDNS, and to register its LetsEncrypt cert for use on its local IP address.

Architecture

localhost:8000   ----   proxy.js   ----  pagekite.py (backend)  ----  pagekite.py (frontend)  ----  browser
                              \  \                                                                /  /
                               \   ----  DNS api  ----  DNS server  -----------------------------   /
                                \                             /                                    /
                                  ----  LetsEncrypt API  ----    (-  -  -  -)   LetsEncrypt trust

Usage

Run the server (with DNS on localhost udp port 53 and its API on tcp port 5300):

cd server
npm install
sudo node index test/fixtures/certs/ 53 5300 box.knilxof.org

Or with Docker:

docker build -t pagekite-letsencrypt server/
docker run -d -v /home/ec2-user/certdir:/certdir --net=host -e DOMAIN=box.knilxof.org -e SECRET=foxbox pagekite-letsencrypt

Run the tests (from the repo root):

jshint server/*.js server/test/*.js client/*.js client/scripts/*.js
jscs server/*.js server/test/*.js client/*.js client/scripts/*.js
cd server
sudo node test/dns-query_test.js

This server cannot be used on localhost, because it requires real-world DNS resolution. But an instance of it is running on our knilxof.org dev server. To try it out, run:

cd client
sh ./run.sh knilxof.org box.knilxof.org