diff --git a/guide/quick-start.md b/guide/quick-start.md index 0e1d194..6b15098 100644 --- a/guide/quick-start.md +++ b/guide/quick-start.md @@ -50,7 +50,7 @@ docker run -d --name mqtt --network=host \ ``` #### Deploy Server Docker -There is two config file: `application.conf` and `logback.xml`, you can get the example here. +There is two config file: `application.conf` and `logback.xml`, you can get the example here. More details about config can be found [here](config.md). ```shell diff --git a/guide/quick-test.md b/guide/quick-test.md new file mode 100644 index 0000000..b1bd02e --- /dev/null +++ b/guide/quick-test.md @@ -0,0 +1,27 @@ +# Quick Test +This is for quick test. +## linux +### Backend +```shell +# cd $fornet_project_path +docker start mqtt nginx postgres +# docker rmi ghcr.io/fornetcode/fornet-backend:latest + +docker run --rm -v $PWD/backend/src/main/resources:/config --network=host ghcr.io/fornetcode/fornet-backend:latest +``` + +### Client +```shell +wget https://github.com/ForNetCode/fornet/releases/download/v0.1.0/fornet-linux-x86_64.tar.gz + +#docker run +``` + +## Windows +### Client +```pwsh +wget https://github.com/ForNetCode/fornet/releases/download/v0.1.0/fornet-win11-x86_64.zip + +``` + +## \ No newline at end of file diff --git a/package.json b/package.json index e6f14b6..5543577 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "private": true, - "version": "0.1.0", + "version": "0.2.0", "directories": { "doc": "./" }, diff --git a/plan.md b/plan.md index 58c5063..3cb79ca 100644 --- a/plan.md +++ b/plan.md @@ -1,33 +1,28 @@ # Roadmap +If you have any idea, feel free to open issue. +## Firstly To Do -## Doing Feature -- [ ] Android App +## Secondly To Do +* Desktop App (0.2 or 0.3 Vesrion) +* error info report to server +* Windows auto launch +* DNS(DNS Resolver) +* usage statistic(server) -## Plan Feature(No Order) -- [ ] Windows auto launch -- [ ] admin web turn to white theme -- [ ] admin web tutoril(blocked by white theme) -- [ ] Win10 support -- [ ] punch hole(p2p) -- [ ] error info report to server -- [ ] iOS App -- [ ] DNS(DNS Resolver) -- [ ] WireGuard Relay support -- [ ] mDNS support for Lan -- [ ] usage statistic(server) -- [ ] Ingress、Outgress -- [ ] Ingress LoadBalance -- [ ] k8s deploy -- [ ] OpenBSD/FreeBSD support -- [ ] Windows arm64 support -- [ ] Windows Tun Driver performance improve(all in driver, only provide api to userspace) -- [ ] run without manager sc-manager, read config from local file -## Blocked Feature -- [x] MacOS desktop(release when user really need it) -- [x] Windows desktop(release when user really need it) -- [ ] Linux desktop +## Easy To Do +* user online status show at admin web +* admin web change to white theme +* admin web tutorial (0.1.x Version) -## Thinking Feature -replace wireguard to webrtc, then P2P is more easy to be done. \ No newline at end of file +## Blocked, Waiting For User Feedback +* Android App +* Win10 support +* iOS App +* OpenBSD/FreeBSD support +* Windows arm64 support + + +## Just remark +* Windows Tun Driver performance improve(all in driver, only provide api to userspace) \ No newline at end of file diff --git a/version_change.md b/version_change.md index 0a15fea..6164ef8 100644 --- a/version_change.md +++ b/version_change.md @@ -1,5 +1,15 @@ ## Changelog +### V0.2.0 +- [x] support WebRTC protocol and turn relay(add doc) + + +### V0.1.1 +This is a fixed bug version, we have tested it in production environment of SAAS, and every thing is ok. +- [x] fix: multifarious bugs +- [x] feat: aarch64 client support with Github Actions, make the distribution zip file more clean +- [x] feat: add SAAS production config and bash + ### V0.1.0 **This is not compatible with V0.0.4.**