Giter Site home page Giter Site logo

heimdall's Introduction

heimdall - a https reverse proxy

License:MIT

Heimdall is a https reverse proxy to act as a single gateway for multiple http sites, requiring only a single https setup. It utlizies hyper for http/2 handling based on async/await.

It strips the hop-by-hop headers, adds or extends the 'x-forwarded-for' header with the client ip and returns an unmodified http response from the backend.

This project is still in its infancy, so beware.

Usage

TLS

Heimdall is intended to run in LetsEncrypt ACME scenarios an therefore requires the certificate chain and private key file to be PEM formated.

For testing purposes a self signed certificate can be created with

openssl req -x509 -newkey rsa:4096 -keyout privkey.pem -out fullchain.pem -days 365 -nodes

Standalone binary

  1. Write a config file to <CONFIG_FILE> and adjust accordingly
heimdall default $CONFIG_FILE
  1. Run heimdall from config file <CONFIG_FILE>
heimdall run $CONFIG_FILE

RPM (systemd service)

  1. Build RPM if necessary
./publish_rpm.sh 
export RPM="./target/release/rpmbuild/RPMS/<ARCH>/heimdall-X.Y.Z-N.arch.rpm"
  1. Install with 'su' or 'sudo'
sudo yum install $RPM 
# or 
sudo dnf install $RPM 
  1. Create a configuration file and adjust accordingly
sudo heimdall default /etc/heimdall.toml
# If you use a different path for the config file 
# make sure to edit the heimdall.service file accordingly
  1. Start service
sudo systemctl start heimdall 

heimdall's People

Contributors

dpmkl avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.