dorian
/
mirror-server
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
A simple server for mirroring HTTP requests for testing.
35 Commits 1 Branch 1 Tag 85 KiB
Rust 85.2%
Dockerfile 7.8%
Shell 7%
Go to file
Dorian f14963a2c4
continuous-integration/drone/push Build is failing Details
Add a sample curl and JSON response to the API. 		2024-02-24 10:04:22 -05:00
examples Add a sample curl and JSON response to the API. 2024-02-24 10:04:22 -05:00
src Add a sample curl and JSON response to the API. 2024-02-24 10:04:22 -05:00
.dockerignore Add a Dockerfile and initial DroneCI configuration. 2024-02-21 23:17:17 -05:00
.drone.yml Improve the documentation and ensure tags only are released. 2024-02-23 15:41:43 -05:00
.gitignore Migrate to using axum over actix for web framework. 2024-02-06 15:51:30 -05:00
Cargo.toml Add tests for the mirror-server handling of requests. 2024-02-21 21:38:20 -05:00
Dockerfile Fix issue with source code not ending up in the release. 2024-02-23 15:35:10 -05:00
LICENSE Wire up project for working with actix. 2023-01-12 09:41:47 -05:00
README.md Improve the documentation of the crate. 2024-02-24 08:51:09 -05:00
publish-deb.sh Update README and improve publishing script. 2024-02-23 14:29:48 -05:00

README.md

mirror-server

A simple server for mirroring HTTP requests for testing. It is optimized for working with REST API JSON calls, and catching headers.

Build Status

Getting Started

  • Use the latest stable version of Rust using rustup.
  • Build: cargo build
  • Test: cargo test
  • Run the server: cargo run -- --port=8080
  • Create a DEB package:
    • Install cargo-deb: cargo install cargo-deb
    • Create the DEB package: cargo deb
  • Faster builds using cargo-watch: cargo watch -x run
  • Installing the binary locally from source: cargo install --path .

Install

mirror-server is installable either by a local Cargo install or a Debian package. Additionally mirror-server can be run as a Docker container using the latest (or tagged) release.

Docker Image

Run via Docker using:

$ docker run -p 8080:8080 code.birch-tree.net/dorian/mirror-server:latest

Debian Package

Download the DEB file, and install it:

VERSION=0.3.0
REPO_URL=https://code.birch-tree.net/api/packages/dorian/generic/mirror-server/
curl "${REPO_URL}/${VERSION}/mirror-server_${VERSION}_amd64.deb"
sudo dpkg -i "mirror-server-${VERSION}_amd64.deb"

Afterward you can run using mirror-server

Usage

$ mirror-server --help
A simple server for mirror HTTP requests for testing.

Usage: mirror-server [OPTIONS]

Options:
  -p, --port <PORT>  Port to run on [default: 8080]
  -i, --ips <IPS>    Listen to IP mask [default: 0.0.0.0]
  -h, --help         Print help
  -V, --version      Print version