mirror of https://github.com/wg-easy/wg-easy
Browse Source
* initial support for initial setup * improve setup * improve mobile view * move base admin route * admin panel mobile view * set initial host and port * add docs * properly setup everything, use for dev env * change userconfig and interface port on setup, note users afterwardspull/1740/head
Bernd Storath
3 weeks ago
committed by
GitHub
GitHub
26 changed files with 277 additions and 129 deletions
@ -0,0 +1,32 @@ |
|||||
|
--- |
||||
|
title: Unattended Setup |
||||
|
--- |
||||
|
|
||||
|
If you want to run the setup without any user interaction, e.g. with a tool like Ansible, you can use these environment variables to configure the setup. |
||||
|
|
||||
|
These will only be used during the first start of the container. After that, the setup will be disabled. |
||||
|
|
||||
|
| Env | Example | Description | Group | |
||||
|
| ---------------- | ----------------- | --------------------------------------------------------- | ----- | |
||||
|
| `INIT_ENABLED` | `true` | Enables the below env vars | 0 | |
||||
|
| `INIT_USERNAME` | `admin` | Sets admin username | 1 | |
||||
|
| `INIT_PASSWORD` | `Se!ureP%ssw` | Sets admin password | 1 | |
||||
|
| `INIT_HOST` | `vpn.example.com` | Host clients will connect to | 1 | |
||||
|
| `INIT_PORT` | `51820` | Port clients will connect to and wireguard will listen on | 1 | |
||||
|
| `INIT_DNS` | `1.1.1.1,8.8.8.8` | Sets global dns setting | 2 | |
||||
|
| `INIT_IPV4_CIDR` | `10.8.0.0/24` | Sets IPv4 cidr | 3 | |
||||
|
| `INIT_IPV6_CIDR` | `2001:0DB8::/32` | Sets IPv6 cidr | 3 | |
||||
|
|
||||
|
/// warning | Variables have to be used together |
||||
|
|
||||
|
If variables are in the same group, you have to set all of them. For example, if you set `INIT_IPV4_CIDR`, you also have to set `INIT_IPV6_CIDR`. |
||||
|
|
||||
|
If you want to skip the setup process, you have to configure group `1` |
||||
|
/// |
||||
|
|
||||
|
/// note | Security |
||||
|
|
||||
|
The initial username and password is not checked for complexity. Make sure to set a long enough username and a secure password. Otherwise, the user won't be able to log in. |
||||
|
|
||||
|
Its recommended to remove the variables after the setup is done to prevent the password from being exposed. |
||||
|
/// |
||||
@ -0,0 +1,64 @@ |
|||||
|
<template> |
||||
|
<main v-if="data"> |
||||
|
<FormElement @submit.prevent="submit"> |
||||
|
<FormGroup> |
||||
|
<FormNumberField |
||||
|
id="session" |
||||
|
v-model="data.sessionTimeout" |
||||
|
:label="$t('admin.general.sessionTimeout')" |
||||
|
:description="$t('admin.general.sessionTimeoutDesc')" |
||||
|
/> |
||||
|
</FormGroup> |
||||
|
<FormGroup> |
||||
|
<FormHeading>{{ $t('admin.general.metrics') }}</FormHeading> |
||||
|
<FormNullTextField |
||||
|
id="password" |
||||
|
v-model="data.metricsPassword" |
||||
|
:label="$t('admin.general.metricsPassword')" |
||||
|
:description="$t('admin.general.metricsPasswordDesc')" |
||||
|
/> |
||||
|
<FormSwitchField |
||||
|
id="prometheus" |
||||
|
v-model="data.metricsPrometheus" |
||||
|
:label="$t('admin.general.prometheus')" |
||||
|
:description="$t('admin.general.prometheusDesc')" |
||||
|
/> |
||||
|
<FormSwitchField |
||||
|
id="json" |
||||
|
v-model="data.metricsJson" |
||||
|
:label="$t('admin.general.json')" |
||||
|
:description="$t('admin.general.jsonDesc')" |
||||
|
/> |
||||
|
</FormGroup> |
||||
|
<FormGroup> |
||||
|
<FormHeading>{{ $t('form.actions') }}</FormHeading> |
||||
|
<FormActionField type="submit" :label="$t('form.save')" /> |
||||
|
<FormActionField :label="$t('form.revert')" @click="revert" /> |
||||
|
</FormGroup> |
||||
|
</FormElement> |
||||
|
</main> |
||||
|
</template> |
||||
|
|
||||
|
<script setup lang="ts"> |
||||
|
const { data: _data, refresh } = await useFetch(`/api/admin/general`, { |
||||
|
method: 'get', |
||||
|
}); |
||||
|
const data = toRef(_data.value); |
||||
|
|
||||
|
const _submit = useSubmit( |
||||
|
`/api/admin/general`, |
||||
|
{ |
||||
|
method: 'post', |
||||
|
}, |
||||
|
{ revert } |
||||
|
); |
||||
|
|
||||
|
function submit() { |
||||
|
return _submit(data.value); |
||||
|
} |
||||
|
|
||||
|
async function revert() { |
||||
|
await refresh(); |
||||
|
data.value = toRef(_data.value).value; |
||||
|
} |
||||
|
</script> |
||||
Loading…
Reference in new issue