ergo

README

Ergo

Ergo Proxy - The reverse proxy agent for local domain management.

The management of multiple apps running over different ports made easy through custom local domains for your dev environment.

Demo

More you can see in examples

The Ergo's goal is to be a simple reverse proxy that follows the Unix philosophy of doing only one thing and do it well. Simplicity means no magic involved. Just a flexible reverse proxy that extends the well-known /etc/hosts declaration.

Feedback

This project is under development but it's already usable. Feel free to give me feedback and opening issues. Suggestions and contributions are welcome. :)

Why?

When dealing with multiple apps locally is really annoying having to remember each port that represents each service and it gets even worse when you have microservices. So I wanted a simple way to give a proper local domain for each app. Ergos comes to solve this simple problem.

Installation

OSX using brew

brew tap cristianoliveira/tap
brew install ergo

Linux using scripts

curl -s https://raw.githubusercontent.com/cristianoliveira/ergo/master/install.sh | sh

Using golang

go install github.com/cristianoliveira/ergo

Make sure you have $GOPATH/bin in your path. export PATH=$PATH:$GOPATH/bin

Usage

Ergo looks for a .ergo file inside the current folder. It must contain the names and URL of the services following the same format as the /etc/hosts (domain+space+url) the main difference is that it also considers the port specified.

Let's start:

Simplest Setup

You need to set the http://127.0.0.1:2000/proxy.pac configuration on your system network config

Ergo comes with a setup command that can configure that for you. The current systems supported are:

• osx
• linux-gnome

(Contributions are welcomed)

ergo setup <operation-system>

In case of errors or if it doesn't work please take a look on detailed config session below.

Showtime

echo "ergoproxy http://localhost:3000" > .ergo
ergo run

Now you are able to access: http://ergoproxy.dev. Ergo redirects anything that finish with .dev to the configured url.

Simple right? No magic involved.

Do you want add more services? So is easy, just add more lines in .ergo:

echo "otherservice http://localhost:5000" >> .ergo
ergo list
ergo run

Restart the server and access: http://otherservice.dev

Configuration

In order to use Ergo domains you need to set it as a proxy. Set the http://127.0.0.1:2000/proxy.pac on:

OS X

Network Preferences > Advanced > Proxies > Automatic Proxy Configuration

Windows

Settings > Network and Internet > Proxy > Use setup script

Linux

On Ubuntu

System Settings > Network > Network Proxy > Automatic

For other distributions, check your network manager and look for proxy configuration. Use browser configuration as an alternative.

Browser configuration

Browsers can be configured to use a specific proxy. Use this method as an alternative to system-wide configuration.

Chrome

Exit Chrome and start it using the following option:

# Linux
$ google-chrome --proxy-pac-url=http://localhost:2000/proxy.pac

# OS X
$ open -a "Google Chrome" --args --proxy-pac-url=http://localhost:2000/proxy.pac

Ephemeral Setup

As an alternative you can see the scripts inside /resources for running an ephemeral setup. Those scripts sets the proxy only while ergo is running.

License

MIT