Improve the documentation for the README.
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/push Build is passing
Details
Fix the GLIB issue caused by incompatible Docker images.
This commit is contained in:
parent
6775667f80
commit
f2e5c0e723
|
@ -1,4 +1,4 @@
|
||||||
FROM rust:1.76 AS BUILD
|
FROM rust:1.76-buster AS BUILD
|
||||||
|
|
||||||
ENV APP_NAME=mirror-server
|
ENV APP_NAME=mirror-server
|
||||||
ENV APP_HOME=/srv/${APP_NAME}
|
ENV APP_HOME=/srv/${APP_NAME}
|
||||||
|
|
17
README.md
17
README.md
|
@ -17,6 +17,16 @@ A simple server for mirroring HTTP requests for testing.
|
||||||
|
|
||||||
## Install
|
## 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:
|
Download the DEB file, and install it:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
@ -26,12 +36,9 @@ curl "${REPO_URL}/${VERSION}/mirror-server_${VERSION}_amd64.deb"
|
||||||
sudo dpkg -i "mirror-server-${VERSION}_amd64.deb"
|
sudo dpkg -i "mirror-server-${VERSION}_amd64.deb"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Afterward you can run using `mirror-server`
|
||||||
|
|
||||||
## TODO
|
## 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.
|
* [ ] Add documentation to the API.
|
||||||
* [ ] Publish crate on <https://crates.io/>.
|
* [ ] Publish crate on <https://crates.io/>.
|
||||||
|
|
Loading…
Reference in New Issue