Getting Started

Prerequisites

To use this project you need to have Docker or Podman installed. No other dependencies are required.

Installation

You can download the script and run it from there. Alternatively you can clone the repository and run the script from there

Download the script

curl -O https://raw.githubusercontent.com/dontfreakout/dev-proxy/master/start-proxy.sh

Change permission

Optional: move the script to a directory in your PATH

for example:

mv start-proxy.sh ~/.local/bin/dev-proxy

Usage

Configure containers you want to proxy

You have to configure the containers you want to proxy in the docker-compose.yml file. You need to add the hostname, port and protocol to the environment variables of the container. Also, you need to add the container and the service to the proxy network.

Example configuration:

services:
  my-service:
    networks:
      proxy:
    environment:
      VIRTUAL_HOST: example.localhost
      VIRTUAL_PORT: 80 # port of the service
      VIRTUAL_PROTO: http # (valid options are https or http) if using https, you probably want to use VIRTUAL_PORT: 443

networks:
  proxy:
    name: proxy_network # name of the proxy network needs to be the same as in the script

Configure domains

If you want to use multiple domains on one service you can separate them with a comma.

VIRTUAL_HOST: example.localhost,example2.localhost

Run the script

You can run the script using the following command. This will download docker image and start the proxy with default settings.

Open the proxy localhost page

After starting the proxy, you can open the localhost page in your browser to see all available vhosts.

(Note: If you are using a different port for the proxy, you need to change the URL accordingly, e.g. https://localhost:8443)

Command line options

Usage: ./start-proxy.sh [options] [command]

Commands:

Exposed ports:

The proxy is by default available to local machine on port 80 and 443. You can change this with parameters.

./start-proxy.sh -s 8443 -i 8080

All options:

SSL certificate

The proxy uses a self-signed certificate. To add it to your browser and get rid of the warning you need to import the root certificate. You can follow the steps below to import the certificate.

Chrome

1. Open Chrome and go to chrome://settings/certificates
2. Click on Authorities tab
3. Click on Import
4. Select Root certificate from config folder
   • Linux: ~/.config/dev-proxy/certs/rootCA.crt
   • MacOS: ~/Library/Application Support/dev-proxy/certs/rootCA.crt or ~/.config/dev-proxy/certs/rootCA.crt
5. Click on Trust this certificate for identifying websites
6. Click on OK

Firefox

1. Open Firefox and go to about:preferences#privacy
2. Scroll down and click on View Certificates
3. Click on Authorities
4. Click on Import
5. Select Root certificate from config folder
   • Linux: ~/.config/dev-proxy/certs/rootCA.crt
   • MacOS: ~/Library/Application Support/dev-proxy/certs/rootCA.crt or ~/.config/dev-proxy/certs/rootCA.crt
6. Click on OK

Roadmap

• add option to install as docker service
• possibility to install certificate system-wide
• check for new version and self update

See the open issues for a list of proposed features (and known issues).

Change log

See CHANGELOG.md for more information on what has changed recently.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Build and Deployment

This project uses GitHub Actions to automatically build and deploy Docker images to GitHub Container Registry (ghcr.io) when a new git tag is created.

Creating a new release

1. Update the version in the Dockerfile (LABEL version="x.y.z")
2. Commit and push your changes
3. Create and push a new git tag:

   git tag v1.2.10
   git push origin v1.2.10

4. The GitHub workflow will automatically build the Docker image for both amd64 and arm64 architectures and push it to ghcr.io with the tag matching the git tag.

Manual building

You can also build the image manually using the Makefile:

Or build without caching:

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgments

• nginx-proxy