dorian
/
mirror-server
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve the documentation and bug fixes #3

Merged
dorian merged 13 commits from improve-docs into main 2024-02-24 20:41:15 -05:00
Conversation 0 Commits 13 Files Changed 5 +13 -6
2 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit f2e5c0e723 - Show all commits

2
Dockerfile
View File

@ -1,4 +1,4 @@
FROM rust:1.76 AS BUILD
FROM rust:1.76-buster AS BUILD
ENV APP_NAME=mirror-server
ENV APP_HOME=/srv/${APP_NAME}

17
README.md
View File

@ -17,6 +17,16 @@ A simple server for mirroring HTTP requests for testing.
## Install
### Docker Image
Run via Docker using:
```bash
docker run code.birch-tree.net/dorian/mirror-server:latest
```
### Debian Package
Download the DEB file, and install it:
```bash
@ -26,12 +36,9 @@ curl "${REPO_URL}/${VERSION}/mirror-server_${VERSION}_amd64.deb"
sudo dpkg -i "mirror-server-${VERSION}_amd64.deb"
```
Afterward you can run using `mirror-server`
## 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/>.