38 lines
1.2 KiB
Markdown
38 lines
1.2 KiB
Markdown
# mirror-server
|
|
|
|
A simple server for mirroring HTTP requests for testing.
|
|
|
|
[](https://ci.birch-tree.net/dorian/mirror-server)
|
|
|
|
## 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](https://watchexec.github.io/#cargo-watch): `cargo watch -x run`
|
|
|
|
## Install
|
|
|
|
Download the DEB file, and install it:
|
|
|
|
```bash
|
|
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"
|
|
```
|
|
|
|
## TODO
|
|
|
|
* [x] Migrate actix to axum for easier maintainability.
|
|
* [x] Add mirroring of JSON request.
|
|
* [x] Add logging to server.
|
|
* [x] Create Docker image for mirror-server for easier distribution.
|
|
* [x] Add publishing of DEB and Docker image to DroneCI.
|
|
* [ ] Add documentation to the API.
|
|
* [ ] Publish crate on <https://crates.io/>.
|