Skip to content

Commit 724dadd

Browse files
chore(github-actions): update super-linter/super-linter action to v8 (#557)
* chore(github-actions): update super-linter/super-linter action to v8 * rector main Signed-off-by: Jan-Otto Kröpke <mail@jkroepke.de> --------- Signed-off-by: Jan-Otto Kröpke <mail@jkroepke.de> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Jan-Otto Kröpke <mail@jkroepke.de>
1 parent e2fc0d8 commit 724dadd

File tree

9 files changed

+15
-14
lines changed

9 files changed

+15
-14
lines changed

.github/ISSUE_TEMPLATE/bug_report.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ body:
7878
attributes:
7979
label: openvpn server logs
8080
description: |
81-
Log of openvpn server
81+
Log of OpenVPN server
8282
render: shell
8383
validations:
8484
required: false

.github/workflows/ci.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ jobs:
8989
fetch-depth: 0
9090

9191
- name: Lint Code Base
92-
uses: super-linter/super-linter/slim@12150456a73e248bdc94d0794898f94e23127c88 # v7.4.0
92+
uses: super-linter/super-linter/slim@5119dcd8011e92182ce8219d9e9efc82f16fddb6 # v8.0.0
9393
env:
9494
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
9595
MULTI_STATUS: false

docs/Configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ Usage of openvpn-auth-oauth2:
208208
--openvpn.common-name.mode value
209209
If common names are too long, use md5/sha1 to hash them or omit to skip them. If omit, oauth2.validate.common-name does not work anymore. Values: [plain,omit] (env: CONFIG_OPENVPN_COMMON__NAME_MODE) (default plain)
210210
--openvpn.override-username
211-
Requires OpenVPN Server 2.7! If true, openvpn-auth-oauth2 use the override-username command to set the username in OpenVPN connection. This is useful to use real usernames in OpenVPN statistics. The username will be set after client configs are read. Read openvpn man page for limitations of the override-username. (env: CONFIG_OPENVPN_OVERRIDE__USERNAME)
211+
Requires OpenVPN Server 2.7! If true, openvpn-auth-oauth2 use the override-username command to set the username in OpenVPN connection. This is useful to use real usernames in OpenVPN statistics. The username will be set after client configs are read. Read OpenVPN man page for limitations of the override-username. (env: CONFIG_OPENVPN_OVERRIDE__USERNAME)
212212
--openvpn.pass-through.address value
213213
The address of the pass-through socket. Must start with unix:// or tcp:// (env: CONFIG_OPENVPN_PASS__THROUGH_ADDRESS) (default unix:/run/openvpn-auth-oauth2/server.sock)
214214
--openvpn.pass-through.enabled
@@ -276,7 +276,7 @@ See [Filesystem Permissions](Filesystem%20Permissions) for more information.
276276
277277
## Setup OpenVPN server
278278
279-
To connect openvpn-auth-oauth2 with openvpn server, add lines below:
279+
To connect openvpn-auth-oauth2 with OpenVPN server, add lines below:
280280
281281
```ini
282282
# openvpn server.conf

docs/FAQ.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,21 +28,21 @@ we encourage users to up-vote the relevant feature requests on the OpenVPN GitHu
2828
You can find and support these requests at the following link:
2929
[Feature Request on GitHub](https://github.com/OpenVPN/openvpn/issues/299)
3030

31-
## Q: `mismatch: openvpn client is empty` / `username-as-common-name`
31+
## Q: `mismatch: OpenVPNclient is empty` / `username-as-common-name`
3232

3333
A: When setting up `username-as-common-name` on the OpenVPN server, it's crucial to also configure `openvpn.common-name.environment-variable-name` to `username`.
3434

3535
This configuration is indispensable because `username-as-common-name` functions post-authentication. Aligning the environment variable name with `username` guarantees smooth operation.
3636

3737
On authentication, it's expected that common-name is not the values of the username. That may mis-leading, because after authentication, the common name has the correct value at OpenVPN logs.
3838

39-
**Upstream Issue:** [OpenVPN/openvpn #498](https://github.com/OpenVPN/openvpn/issues/498#issuecomment-1939194149)
39+
**Upstream Issue:** [`OpenVPN/openvpn` #498](https://github.com/OpenVPN/openvpn/issues/498#issuecomment-1939194149)
4040

4141
## Q: Options error: No client-side authentication method is specified.
4242

4343
A: Although openvpn-auth-oauth2 theoretically doesn't require client-side authentication, the OpenVPN client expects it.
4444

45-
**Upstream Issue:** [OpenVPN/openvpn #501](https://github.com/OpenVPN/openvpn/issues/501) (Please react with :+1: if you're affected.)
45+
**Upstream Issue:** [`OpenVPN/openvpn` #501](https://github.com/OpenVPN/openvpn/issues/501) (Please react with :+1: if you're affected.)
4646

4747
**Potential Workarounds:**
4848

docs/Filesystem Permissions.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Filesystem Permissions
22

3-
When started by systemd, openvpn runs with a [dynamic arbitrary UID](https://0pointer.net/blog/dynamic-users-with-systemd.html).
3+
When started by systemd,
4+
OpenVPN runs with a [dynamic arbitrary UID](https://0pointer.net/blog/dynamic-users-with-systemd.html).
45
This means that it may not have access to certain files and directories if the appropriate permissions are not set.
56

67
Any additional files, such as TLS keys, should reside in the `/etc/openvpn-auth-oauth2/` directory.
78
The ownership of these files should be set to `root`, and the group should be set to `openvpn-auth-oauth2`.
8-
This setup ensures that openvpn has the necessary permissions to access and utilize these files.
9+
This setup ensures that OpenVPN has the necessary permissions to access and use these files.
910

1011
When installing the openvpn-auth-oauth2 Linux package, the system automatically creates the openvpn-auth-oauth2 group.
1112
This group manages access to the necessary files and directories

docs/HTTPS Listener.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ You need to install `certbot` and suitable for you `DNS plugin`. More informatio
6868

6969
You can create certs with command below and than copy them to `/etc/openvpn-auth-oauth2/` directory or create a link to files. Do not forget to set right permissions.
7070

71-
The command below uses certbot to create a free SSL certificate for a domain hosted on cloudflare.
71+
The command below uses certbot to create a free SSL certificate for a domain hosted on Cloudflare.
7272

7373
```bash
7474
certbot certonly --noninteractive --verbose \

docs/Installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Replace `<package_file>` with the name of the downloaded file.
4949
## Manual Installation
5050

5151
If you prefer to build the binary yourself, follow these steps:
52-
1. Ensure you have [golang](https://go.dev/doc/install) and Make installed on your system.
52+
1. Ensure you have [Go](https://go.dev/doc/install) and Make installed on your system.
5353
2. Download the source code from our [releases page](https://github.com/jkroepke/openvpn-auth-oauth2/releases/latest).
5454
3. Open a terminal.
5555
4. Navigate to the directory where you downloaded the source code.

docs/Providers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@ To require multiple groups, define `CONFIG_OAUTH2_VALIDATE_GROUPS`.
8383
<details>
8484
<summary>Expand</summary>
8585

86-
### Register an app on google cloud console
86+
### Register an app on Google Cloud Console
8787

88-
1. Login as admin into your [Google console](https://console.cloud.google.com/).
88+
1. Login as admin into your [Google Cloud Console](https://console.cloud.google.com/).
8989
2. In the project Dashboard center pane, choose **"APIs & Services"**.
9090
3. If necessary, complete the `OAuth consent screen` wizard. You will probably want to create an `Internal` application.
9191
* If you reuse an existing application, your users may already have given consent for the usage of this application,

internal/config/flags.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ func (c *Config) flagSetOpenVPN(flagSet *flag.FlagSet) {
181181
"Requires OpenVPN Server 2.7! "+
182182
"If true, openvpn-auth-oauth2 use the override-username command to set the username in OpenVPN connection. "+
183183
"This is useful to use real usernames in OpenVPN statistics. The username will be set after client configs are read. "+
184-
"Read openvpn man page for limitations of the override-username.",
184+
"Read OpenVPN man page for limitations of the override-username.",
185185
)
186186
flagSet.BoolVar(
187187
&c.OpenVPN.Passthrough.Enabled,

0 commit comments

Comments
 (0)