alexwight/marquis

OSX localhost reverse proxy tool

Maintainers

Details

github.com/alexwight/marquis

Source

Issues

Installs: 10

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

0.16 2018-02-17 04:37 UTC

Requires

MIT e0cf52dcd4e218a927ac8b68391f4764da289b98

  • Alex Wight <alex.woop@elder.co.uk>

This package is not auto-updated.

Last update: 2024-04-14 02:50:49 UTC

README

A simple way to point local domains to internal ports

Introduction

Develop on Mac OS and love docker or vagrant for local development?

Sick to death of remembering port numbers you have mapped to your VM's or containers? Join the club.

Marquis is wrapper around DnsMasq and nginx for Mac developers to point a local domain name to a port running on localhost.

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

  • 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]

HTTP

To access target at http://localhost:8080

$ marquis site myapp http 8080

You can now access at http://myapp.test

HTTPS

To access target at https://localhost:8443

$ marquis site myapp https 8443

You can now access at https://myapp.test

SSL Certificate is automatically generated and trusted. HTTP/2 enabled by default.

Docker example

docker pull karthequian/helloworld:latest

docker run -p 8001:80/tcp "karthequian/helloworld:latest"

Site now available at http://127.0.0.1:8001

$ marquis site howdy http 8001

Site also now available at http://howdy.test

SSL Termination

Proxy will handle the SSL termination so can handle https when the backend does not expose it, e.g.

marquis site howdy http 8001 443

Site also now available at https://howdy.tests

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.

License

Marquis is open-sourced software licensed under the MIT license