mkopylec/charon-spring-boot-starter

Reverse proxy implementation in form of a Spring Boot starter.

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.mkopylec:reverse-proxy-spring-boot-starter:4.10.0'
	}
	dependencies {
		implementation("com.github.mkopylec:reverse-proxy-spring-boot-starter:4.10.0")
	}
	<dependency>
	    <groupId>com.github.mkopylec</groupId>
	    <artifactId>reverse-proxy-spring-boot-starter</artifactId>
	    <version>4.10.0</version>
	</dependency>

                            
    libraryDependencies += "com.github.mkopylec" % "reverse-proxy-spring-boot-starter" % "4.10.0"
        
        

                            
    :dependencies [[com.github.mkopylec/reverse-proxy-spring-boot-starter "4.10.0"]]

Readme

Charon Spring Boot Starter

Build Status Code Coverage Maven Central

Charon is a reverse proxy implementation. It automatically forwards HTTP requests from one HTTP server to another and sends back the received HTTP response to the client. There are some alternative reverse proxy implementations like Zuul or Smiley's HTTP Proxy Servlet. Zuul is highly bounded to Spring Cloud Netflix, Smiley's HTTP Proxy Servlet is a simple one, without advanced features. Charon is a universal Spring Boot tool. It already has a lot of features implemented and its architecture provides an easy way to add new ones.

Features

  • highly configurable and extensible
  • Spring WebMVC and WebFlux support
  • multiple request forwarding mappings
  • load balancing
  • flexible path rewriting
  • Resilience4j support
  • metrics based on Micrometer
  • asynchronous request forwarding
  • authentication
  • cookies rewriting
  • 'X-Forwarded' HTTP headers support
  • forwarding process intercepting
  • configurable HTTP client

Migrating from older versions to 4.x.x

Charon was completely rewritten, configuration via application.yml file is no longer available. Now Charon can be configured by in-code configuration. See the documentation for more details.

Documentation

Full documentation is located here.

License

Charon Spring Boot Starter is published under Apache License 2.0.