alexwight/marquis

OSX localhost reverse proxy tool

marquis

A simple way to point local domains to internal ports, _(*1)

Introduction

Develop on Mac OS and love docker or vagrant for local development?, _(*2)

Sick to death of remembering port numbers you have mapped to your VM's or containers? Join the club., _(*3)

Marquis is wrapper around DnsMasq and nginx for Mac developers to point a local domain name to a port running on localhost., _(*4)

Installation

Marquis requires macOS and Homebrew. Before installation, you should make sure that no other programs such as Apache or Nginx are binding to your local machine's port 80, _(*5)

• Install or update Homebrew to the latest version using brew update.
• Install PHP > 5.6 using Homebrew. e.g.$ brew install homebrew/php/php72
• Install Marquis with Composer via $ composer global require alexwight/marquis. Make sure the ~/.composer/vendor/bin directory is in your system's "PATH".
• Run the $ marquis install command. This will configure and install Nginx and DnsMasq.

Usage Examples

marquis site [subdomain] [target protocol] [destination port] [-- listen port], _(*6)

HTTP

To access target at http://localhost:8080, _(*7)

$ marquis site myapp http 8080, _(*8)

You can now access at http://myapp.test, _(*9)

HTTPS

To access target at https://localhost:8443, _(*10)

$ marquis site myapp https 8443, _(*11)

You can now access at https://myapp.test, _(*12)

SSL Certificate is automatically generated and trusted. HTTP/2 enabled by default., _(*13)

Docker example

docker pull karthequian/helloworld:latest, _(*14)

docker run -p 8001:80/tcp "karthequian/helloworld:latest", _(*15)

Site now available at http://127.0.0.1:8001, _(*16)

$ marquis site howdy http 8001, _(*17)

Site also now available at http://howdy.test, _(*18)

SSL Termination

Proxy will handle the SSL termination so can handle https when the backend does not expose it, e.g., _(*19)

marquis site howdy http 8001 443, _(*20)

Site also now available at https://howdy.tests, _(*21)

Problems?

I'm just using this for myself and putting this up there incase anyone else wants it. If you are using this then I assume you are a developer. Fix it and submit a pull request., _(*22)

License

Marquis is open-sourced software licensed under the MIT license, _(*23)