Getting Started with Faroxy

Table of contents

1. Installation
   1. Prerequisites
   2. Quick Install
   3. Docker Installation
2. Basic Usage
   1. Accessing the Web Interface
   2. Using as a Proxy
      1. Simple GET Request
      2. POST Request with JSON
      3. Form Data Submission
3. Configuration
   1. Local Configuration
   2. Environment Variables
4. Next Steps

Installation

Prerequisites

Before installing Faroxy, ensure you have:

• Java 17 or higher
• Gradle 7.x or higher
• Docker (optional)

Quick Install

1. Clone the repository:

   git clone https://github.com/vinipx/faroxy.git
   cd faroxy
   

2. Run with Gradle:

   ./gradlew bootRun
   

Docker Installation

1. Build the image:

   docker build -t faroxy .
   

2. Run the container:

   docker run -p 8080:8080 faroxy
   

Basic Usage

Accessing the Web Interface

1. Open your browser and navigate to http://localhost:8080
2. You’ll see the Faroxy dashboard with:
   • Real-time traffic monitor
   • Request/response details
   • Search and filter options

Using as a Proxy

Simple GET Request

curl "http://localhost:8080/proxy?url=https://api.example.com/data"

POST Request with JSON

curl -X POST "http://localhost:8080/proxy?url=https://api.example.com/data" \
     -H "Content-Type: application/json" \
     -d '{"key": "value"}'

Form Data Submission

curl -X POST "http://localhost:8080/proxy?url=https://api.example.com/data" \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -d "key1=value1&key2=value2"

Configuration

Local Configuration

1. Create your local config:

   cp src/main/resources/application-local.properties.template config/application-local.properties
   

2. Edit the configuration:

   server.port=9090
   faroxy.proxy.port=9999
   logging.level.io.faroxy=DEBUG
   

Environment Variables

Override settings using environment variables:

export SERVER_PORT=9090
export SPRING_DATASOURCE_URL=jdbc:h2:mem:customdb

Next Steps

• Learn about Advanced Features
• Explore the API Reference
• Check out Configuration Options