#nginx #setup #local #command-line-tool #environment #domain #dev

bin+lib taco_dev

A Rust command line tool that setup a local domain environment for development using nginx and dnsmasq

1 unstable release

Uses old Rust 2015

0.1.0 Jan 26, 2018

#32 in #nginx

MIT license

10KB
196 lines

taco_dev

A command line tool to setup a local domain environment for development using nginx and dnsmasq.

Status: Not ready.

TacoDev 0.1.0
Fraser Xu <xvfeng123@gmail.com>
Taco Dev

USAGE:
    taco_dev [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    dnsmasq    Set up dnsmasq
    help       Prints this message or the help of the given subcommand(s)
    nginx      Set up NGINX
    reload     Restart nginx

Requirements

  • dnsmasq - Dnsmasq provides network infrastructure for small networks: DNS, DHCP, router advertisement and network boot.
  • nginx - HTTP and reverse proxy server.

If you are on Mac and has howebrew installed, simply run homebrew install dnsmasq nginx.

Usage

  1. Setup dnsmasq
$ taco_dev dnsmasq --domain=test

To verify:

$ ping taco_dev.test
PING taco_dev.test (127.0.0.1): 56 data bytes
  1. Setup nginx

To tell nginx to proxy a request to port 80, we need to defined the upstream server. It can be either a local server running on a specific port localhost:8080 or a unix socket object unix:/tmp/example.test.

$ taco_dev nginx --upstream=127.0.0.1:8000 --server=taco_dev.test --root=/Users/fraserxu/projects/taco_dev;

This will add a taco_dev.conf in nginx/servers directory.

upstream taco_dev.test {
    server unix:/tmp/taco_dev;
}

server {
    listen 80;
    server_name taco_dev.test;
    root /Users/fraserxu/projects/taco_dev;

    try_files $uri/index.html $uri @taco_dev.test;

    location @taco_dev.test {
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_redirect off;

        proxy_pass http://taco_dev.test;
    }
}
  1. Reload nginx and 🎉
$ taco_dev reload
$ open http://taco_dev.test

License

MIT

Dependencies

~1.5MB
~25K SLoC