mirror of
https://github.com/vx3r/wg-gen-web.git
synced 2024-11-22 02:31:57 +01:00
update readme, some improvements in error handling
This commit is contained in:
parent
3c155f1c97
commit
76434020af
24
README.md
24
README.md
@ -46,7 +46,7 @@ The easiest way to run Wg Gen Web is using the container image
|
|||||||
```
|
```
|
||||||
docker run --rm -it -v /tmp/wireguard:/data -p 8080:8080 -e "WG_CONF_DIR=/data" vx3r/wg-gen-web:latest
|
docker run --rm -it -v /tmp/wireguard:/data -p 8080:8080 -e "WG_CONF_DIR=/data" vx3r/wg-gen-web:latest
|
||||||
```
|
```
|
||||||
Docker compose snippet, used for demo server
|
Docker compose snippet, used for demo server, wg-json-api service is optional
|
||||||
```
|
```
|
||||||
version: '3.6'
|
version: '3.6'
|
||||||
wg-gen-web-demo:
|
wg-gen-web-demo:
|
||||||
@ -70,6 +70,14 @@ version: '3.6'
|
|||||||
- OAUTH2_REDIRECT_URL=https://wg-gen-web-demo.127-0-0-1.fr
|
- OAUTH2_REDIRECT_URL=https://wg-gen-web-demo.127-0-0-1.fr
|
||||||
volumes:
|
volumes:
|
||||||
- /etc/wireguard:/data
|
- /etc/wireguard:/data
|
||||||
|
wg-json-api:
|
||||||
|
image: james/wg-api:latest
|
||||||
|
container_name: wg-json-api
|
||||||
|
restart: unless-stopped
|
||||||
|
cap_add:
|
||||||
|
- NET_ADMIN
|
||||||
|
network_mode: "host"
|
||||||
|
command: wg-api --device wg0 --listen localhost:8182
|
||||||
```
|
```
|
||||||
Please note that mapping ```/etc/wireguard``` to ```/data``` inside the docker, will erase your host's current configuration.
|
Please note that mapping ```/etc/wireguard``` to ```/data``` inside the docker, will erase your host's current configuration.
|
||||||
If needed, please make sure to backup your files from ```/etc/wireguard```.
|
If needed, please make sure to backup your files from ```/etc/wireguard```.
|
||||||
@ -177,9 +185,21 @@ OAUTH2_CLIENT_SECRET=********************
|
|||||||
OAUTH2_REDIRECT_URL=https://wg-gen-web-demo.127-0-0-1.fr
|
OAUTH2_REDIRECT_URL=https://wg-gen-web-demo.127-0-0-1.fr
|
||||||
```
|
```
|
||||||
|
|
||||||
Please fell free to test and report any bugs.
|
|
||||||
Wg Gen Web will only access your profile to get email address and your name, no other unnecessary scopes will be requested.
|
Wg Gen Web will only access your profile to get email address and your name, no other unnecessary scopes will be requested.
|
||||||
|
|
||||||
|
## WireGuard Status Display
|
||||||
|
Wg Gen Web integrates a [WireGuard API implementation](https://github.com/jamescun/wg-api) to display client stats.
|
||||||
|
In order to enable the Status API integration, the following settings need to be configured:
|
||||||
|
```
|
||||||
|
# https://github.com/jamescun/wg-api integration, user and password (basic auth) are optional
|
||||||
|
WG_STATS_API=http://localhost:8182
|
||||||
|
WG_STATS_API_USER=
|
||||||
|
WG_STATS_API_PASS=
|
||||||
|
```
|
||||||
|
To setup the WireGuard API take a look at [https://github.com/jamescun/wg-api/blob/master/README.md](https://github.com/jamescun/wg-api/blob/master/README.md).
|
||||||
|
|
||||||
|
Please fell free to test and report any bugs.
|
||||||
|
|
||||||
## Need Help
|
## Need Help
|
||||||
|
|
||||||
* Join us on [Discord](https://discord.gg/fjx7gGJ)
|
* Join us on [Discord](https://discord.gg/fjx7gGJ)
|
||||||
|
@ -2,6 +2,7 @@ package status
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"os"
|
||||||
|
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
log "github.com/sirupsen/logrus"
|
log "github.com/sirupsen/logrus"
|
||||||
@ -12,11 +13,16 @@ import (
|
|||||||
func ApplyRoutes(r *gin.RouterGroup) {
|
func ApplyRoutes(r *gin.RouterGroup) {
|
||||||
g := r.Group("/status")
|
g := r.Group("/status")
|
||||||
{
|
{
|
||||||
|
g.GET("/enabled", readEnabled)
|
||||||
g.GET("/interface", readInterfaceStatus)
|
g.GET("/interface", readInterfaceStatus)
|
||||||
g.GET("/clients", readClientStatus)
|
g.GET("/clients", readClientStatus)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func readEnabled(c *gin.Context) {
|
||||||
|
c.JSON(http.StatusOK, os.Getenv("WG_STATS_API") != "")
|
||||||
|
}
|
||||||
|
|
||||||
func readInterfaceStatus(c *gin.Context) {
|
func readInterfaceStatus(c *gin.Context) {
|
||||||
status, err := core.ReadInterfaceStatus()
|
status, err := core.ReadInterfaceStatus()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
@ -80,7 +80,8 @@
|
|||||||
<v-card-title>
|
<v-card-title>
|
||||||
No stats available...
|
No stats available...
|
||||||
</v-card-title>
|
</v-card-title>
|
||||||
<v-card-text>{{ error }}</v-card-text>
|
<v-card-text v-if="enabled">{{ error }}</v-card-text>
|
||||||
|
<v-card-text v-else>Status API integration not configured.</v-card-text>
|
||||||
</v-card>
|
</v-card>
|
||||||
</v-col>
|
</v-col>
|
||||||
</v-row>
|
</v-row>
|
||||||
@ -109,26 +110,32 @@
|
|||||||
...mapGetters({
|
...mapGetters({
|
||||||
interface: 'status/interfaceStatus',
|
interface: 'status/interfaceStatus',
|
||||||
clients: 'status/clientStatus',
|
clients: 'status/clientStatus',
|
||||||
|
enabled: 'status/enabled',
|
||||||
error: 'status/error',
|
error: 'status/error',
|
||||||
}),
|
}),
|
||||||
dataLoaded: function () {
|
dataLoaded: function () {
|
||||||
return this.interface != null && this.interface.name !== "";
|
return this.enabled && this.interface != null && this.interface.name !== "";
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
mounted () {
|
mounted () {
|
||||||
this.readStatus()
|
this.readEnabled()
|
||||||
|
if(this.enabled) {
|
||||||
|
this.readStatus()
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
methods: {
|
methods: {
|
||||||
...mapActions('status', {
|
...mapActions('status', {
|
||||||
readStatus: 'read',
|
readStatus: 'read',
|
||||||
|
readEnabled: 'isEnabled',
|
||||||
}),
|
}),
|
||||||
|
|
||||||
reload() {
|
reload() {
|
||||||
this.readStatus()
|
this.readStatus()
|
||||||
},
|
},
|
||||||
|
|
||||||
|
// https://stackoverflow.com/questions/10420352/converting-file-size-in-bytes-to-human-readable-string
|
||||||
humanFileSize(bytes, si=false, dp=1) {
|
humanFileSize(bytes, si=false, dp=1) {
|
||||||
const thresh = si ? 1000 : 1024;
|
const thresh = si ? 1000 : 1024;
|
||||||
|
|
||||||
|
@ -10,9 +10,13 @@ const ApiService = {
|
|||||||
get(resource) {
|
get(resource) {
|
||||||
return Vue.axios.get(resource)
|
return Vue.axios.get(resource)
|
||||||
.then(response => response.data)
|
.then(response => response.data)
|
||||||
.catch(error => {
|
.catch(error => {
|
||||||
throw new Error(`ApiService: ${error}`)
|
if(typeof error.response !== 'undefined') {
|
||||||
});
|
throw new Error(`${error.response.status} - ${error.response.statusText}: ${error.response.data}`)
|
||||||
|
} else {
|
||||||
|
throw new Error(`ApiService: ${error}`)
|
||||||
|
}
|
||||||
|
});
|
||||||
},
|
},
|
||||||
|
|
||||||
post(resource, params) {
|
post(resource, params) {
|
||||||
|
@ -2,6 +2,7 @@ import ApiService from "../../services/api.service";
|
|||||||
|
|
||||||
const state = {
|
const state = {
|
||||||
error: null,
|
error: null,
|
||||||
|
enabled: false,
|
||||||
interfaceStatus: null,
|
interfaceStatus: null,
|
||||||
clientStatus: [],
|
clientStatus: [],
|
||||||
version: '_ci_build_not_run_properly_',
|
version: '_ci_build_not_run_properly_',
|
||||||
@ -12,6 +13,10 @@ const getters = {
|
|||||||
return state.error;
|
return state.error;
|
||||||
},
|
},
|
||||||
|
|
||||||
|
enabled(state) {
|
||||||
|
return state.enabled;
|
||||||
|
},
|
||||||
|
|
||||||
interfaceStatus(state) {
|
interfaceStatus(state) {
|
||||||
return state.interfaceStatus;
|
return state.interfaceStatus;
|
||||||
},
|
},
|
||||||
@ -48,6 +53,17 @@ const actions = {
|
|||||||
commit('error', err)
|
commit('error', err)
|
||||||
});
|
});
|
||||||
},
|
},
|
||||||
|
|
||||||
|
isEnabled({ commit }){
|
||||||
|
ApiService.get("/status/enabled")
|
||||||
|
.then(resp => {
|
||||||
|
commit('enabled', resp)
|
||||||
|
})
|
||||||
|
.catch(err => {
|
||||||
|
commit('enabled', false);
|
||||||
|
commit('error', err.response.data)
|
||||||
|
});
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
const mutations = {
|
const mutations = {
|
||||||
@ -55,6 +71,10 @@ const mutations = {
|
|||||||
state.error = error;
|
state.error = error;
|
||||||
},
|
},
|
||||||
|
|
||||||
|
enabled(state, enabled) {
|
||||||
|
state.enabled = enabled;
|
||||||
|
},
|
||||||
|
|
||||||
interfaceStatus(state, interfaceStatus){
|
interfaceStatus(state, interfaceStatus){
|
||||||
state.interfaceStatus = interfaceStatus
|
state.interfaceStatus = interfaceStatus
|
||||||
},
|
},
|
||||||
|
Loading…
Reference in New Issue
Block a user