From e0d8d6132b63db0458eb770cb31590766fcc23dd Mon Sep 17 00:00:00 2001 From: "deepsource-autofix[bot]" <62050782+deepsource-autofix[bot]@users.noreply.github.com> Date: Wed, 23 Jul 2025 07:14:37 +0000 Subject: [PATCH] style: format code with Prettier This commit fixes the style issues introduced in 6688c6e according to the output from Prettier. Details: None --- README.md | 2 +- docs/awesome-remnawave.md | 6 +- docs/guides/warp-outbound-over-wg.md | 136 +++++++++--------- docs/install/aura-subscriptions.md | 1 + docs/install/environment-variables.md | 20 +-- .../panel-security/tinyAuth-for-nginx.md | 25 ++-- docs/overview/components.md | 1 - docs/sdk/python-sdk.md | 2 +- docs/sdk/typescript-sdk.md | 22 +-- docusaurus.config.ts | 4 +- src/css/custom.css | 60 ++++---- src/theme/DocCard/styles.module.css | 24 ++-- .../overrides/card/card.module.css | 2 +- 13 files changed, 158 insertions(+), 147 deletions(-) diff --git a/README.md b/README.md index 0b31374..a5bbe29 100644 --- a/README.md +++ b/README.md @@ -3,4 +3,4 @@
A powerful proxy management tool, built on top of Xray-core, with a focus on simplicity and ease of use.
-
\ No newline at end of file
+
diff --git a/docs/awesome-remnawave.md b/docs/awesome-remnawave.md
index 0611c23..6370f6a 100644
--- a/docs/awesome-remnawave.md
+++ b/docs/awesome-remnawave.md
@@ -222,9 +222,9 @@ The application requires the following environment variables to be set:
| Variable | Description |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `REMNAWAVE_URL` | Aura API PLAIN DOMAIN(panel.domain.com) |
-| `REMNAWAVE_MODE` | Aura mode (remote/local), default is remote. If local set – you can pass aura-backend:3000 to REMNAWAVE_URL |
-| `REMNAWAVE_TOKEN` | Authentication token for Aura API |
+| `REMNAWAVE_URL` | Aura API PLAIN DOMAIN(panel.domain.com) |
+| `REMNAWAVE_MODE` | Aura mode (remote/local), default is remote. If local set – you can pass aura-backend:3000 to REMNAWAVE_URL |
+| `REMNAWAVE_TOKEN` | Authentication token for Aura API |
| `BUY_LINK` | The URL for purchase actions |
| `CRYPTO_LINK` | Allows using encrypted links (currently supported Happ application) |
| `REDIRECT_LINK` | Allows you to specify a **custom redirect page URL** for deep links. Useful for handling protocols like `v2box://` in Telegram Desktop (Windows). For more details and examples, see [Telegram Deep Link Redirect](https://github.com/maposia/redirect-page/tree/main) |
diff --git a/docs/guides/warp-outbound-over-wg.md b/docs/guides/warp-outbound-over-wg.md
index 06ac49e..df3f4c6 100644
--- a/docs/guides/warp-outbound-over-wg.md
+++ b/docs/guides/warp-outbound-over-wg.md
@@ -1,6 +1,6 @@
---
sidebar_position: 3
-title: WARP outbound over WireGuard (Without warp-cli)
+title: WARP outbound over WireGuard (Without warp-cli)
---
## Setting Up WireGuard with Wgcf (Without `warp-cli`)
@@ -23,6 +23,7 @@ This guide explains how to configure **WireGuard** using **Wgcf**, without relyi
Go to: [Releases · ViRb3/wgcf (GitHub)](https://github.com/ViRb3/wgcf/releases)
Choose the version that matches your system. Example for Linux AMD64:
+
```bash title="Download command"
wget https://github.com/ViRb3/wgcf/releases/download/v2.2.26/wgcf_2.2.26_linux_amd64
```
@@ -48,9 +49,11 @@ chmod +x /usr/bin/wgcf
### 4. Register account
This will generate a configuration file:
+
```bash title="Register new account"
wgcf register
```
+
A file named `wgcf-account.toml` will be created.
---
@@ -60,6 +63,7 @@ A file named `wgcf-account.toml` will be created.
```bash title="Generate config"
wgcf generate
```
+
A file named `wgcf-profile.conf` will appear.
---
@@ -67,12 +71,14 @@ A file named `wgcf-profile.conf` will appear.
### 6. Extract keys from config
Open the generated file:
+
```bash title="View config"
cat wgcf-profile.conf
```
You’ll see two important fields:
-- `PrivateKey`
+
+- `PrivateKey`
- `PublicKey`
---
@@ -83,20 +89,20 @@ Add the following to your XRAY config under `outbounds`:
```json title="XRAY WireGuard outbound example"
{
- "tag": "warp",
- "protocol": "wireguard",
- "settings": {
- "secretKey": "YOUR_PRIVATE_KEY_FROM_FILE",
- "DNS": "1.1.1.1",
- "kernelMode": false,
- "address": ["172.16.0.2/32"],
- "peers": [
- {
- "publicKey": "YOUR_PUBLIC_KEY_FROM_FILE",
- "endpoint": "engage.cloudflareclient.com:2408"
- }
- ]
- }
+ "tag": "warp",
+ "protocol": "wireguard",
+ "settings": {
+ "secretKey": "YOUR_PRIVATE_KEY_FROM_FILE",
+ "DNS": "1.1.1.1",
+ "kernelMode": false,
+ "address": ["172.16.0.2/32"],
+ "peers": [
+ {
+ "publicKey": "YOUR_PUBLIC_KEY_FROM_FILE",
+ "endpoint": "engage.cloudflareclient.com:2408"
+ }
+ ]
+ }
}
```
@@ -106,49 +112,49 @@ Add the following to your XRAY config under `outbounds`:
```json title="Full outbound list with WARP"
[
- {
- "tag": "DIRECT",
- "protocol": "freedom",
- "settings": {
- "domainStrategy": "ForceIPv4"
- }
- },
- // highlight-next-line-green
- {
- // highlight-next-line-yellow
- "tag": "warp",
- // highlight-next-line-green
- "protocol": "wireguard",
- // highlight-next-line-green
- "settings": {
-// highlight-next-line-green
- "secretKey": "MISEK000000000000000000vim6zWY=",
-// highlight-next-line-green
- "DNS": "1.1.1.1",
-// highlight-next-line-green
- "kernelMode": false,
-// highlight-next-line-green
- "address": ["172.16.0.2/32"],
-// highlight-next-line-green
- "peers": [
-// highlight-next-line-green
- {
-// highlight-next-line-green
- "publicKey": "bm00000000000000000Vo510h2wPfgyo=",
-// highlight-next-line-green
- "endpoint": "engage.cloudflareclient.com:2408"
-// highlight-next-line-green
+ {
+ "tag": "DIRECT",
+ "protocol": "freedom",
+ "settings": {
+ "domainStrategy": "ForceIPv4"
+ }
+ },
+ // highlight-next-line-green
+ {
+ // highlight-next-line-yellow
+ "tag": "warp",
+ // highlight-next-line-green
+ "protocol": "wireguard",
+ // highlight-next-line-green
+ "settings": {
+ // highlight-next-line-green
+ "secretKey": "MISEK000000000000000000vim6zWY=",
+ // highlight-next-line-green
+ "DNS": "1.1.1.1",
+ // highlight-next-line-green
+ "kernelMode": false,
+ // highlight-next-line-green
+ "address": ["172.16.0.2/32"],
+ // highlight-next-line-green
+ "peers": [
+ // highlight-next-line-green
+ {
+ // highlight-next-line-green
+ "publicKey": "bm00000000000000000Vo510h2wPfgyo=",
+ // highlight-next-line-green
+ "endpoint": "engage.cloudflareclient.com:2408"
+ // highlight-next-line-green
+ }
+ // highlight-next-line-green
+ ]
+ // highlight-next-line-green
}
-// highlight-next-line-green
- ]
-// highlight-next-line-green
+ // highlight-next-line-green
+ },
+ {
+ "tag": "BLOCK",
+ "protocol": "blackhole"
}
-// highlight-next-line-green
- },
- {
- "tag": "BLOCK",
- "protocol": "blackhole"
- }
]
```
@@ -160,16 +166,10 @@ To route certain domains through WARP, add the following to the `routing` sectio
```json title="Routing rule example"
{
-// highlight-next-line-yellow
- "outboundTag": "warp",
- "domain": [
- "geosite:google-gemini",
- "openai.com",
- "ipinfo.io",
- "spotify.com",
- "canva.com"
- ],
- "type": "field"
+ // highlight-next-line-yellow
+ "outboundTag": "warp",
+ "domain": ["geosite:google-gemini", "openai.com", "ipinfo.io", "spotify.com", "canva.com"],
+ "type": "field"
}
```
@@ -183,4 +183,4 @@ To route certain domains through WARP, add the following to the `routing` sectio
### Conclusion
-Using **WireGuard with Wgcf** is a clean and scalable way to connect to **Cloudflare WARP** without installing `warp-cli`.
+Using **WireGuard with Wgcf** is a clean and scalable way to connect to **Cloudflare WARP** without installing `warp-cli`.
diff --git a/docs/install/aura-subscriptions.md b/docs/install/aura-subscriptions.md
index df2c133..17253c0 100644
--- a/docs/install/aura-subscriptions.md
+++ b/docs/install/aura-subscriptions.md
@@ -700,6 +700,7 @@ Some applications require the subscription URL to be Base64 encoded:
This can be helpful if you want fully change UI of the subscription page.
- **The `index.html` file and all files in the `assets` directory must be mounted into the container at the following paths:**
+
```yaml
volumes:
- ./index.html:/opt/app/frontend/index.html
diff --git a/docs/install/environment-variables.md b/docs/install/environment-variables.md
index c831139..13c9ba1 100644
--- a/docs/install/environment-variables.md
+++ b/docs/install/environment-variables.md
@@ -23,10 +23,10 @@ cd /opt/aura && nano .env
## Ports
-| Variable | Description | Default |
-| -------------- | -------------------------------------- | ------- |
+| Variable | Description | Default |
+| -------------- | --------------------------------- | ------- |
| `APP_PORT` | The port to run the Aura Panel on | `3000` |
-| `METRICS_PORT` | The port to run Metrics endpoints | `3001` |
+| `METRICS_PORT` | The port to run Metrics endpoints | `3001` |
Example
@@ -71,12 +71,12 @@ API_INSTANCES=1
## Redis
-| Variable | Description | Default | Required |
-| ---------------- | -------------------------------- | ----------------- | -------- |
+| Variable | Description | Default | Required |
+| ---------------- | -------------------------------- | ------------ | -------- |
| `REDIS_HOST` | The host of the Redis server | `aura-redis` | Yes |
-| `REDIS_PORT` | The port of the Redis server | `6379` | Yes |
-| `REDIS_DB` | The database of the Redis server | `0` | No |
-| `REDIS_PASSWORD` | The password of the Redis server | | No |
+| `REDIS_PORT` | The port of the Redis server | `6379` | Yes |
+| `REDIS_DB` | The database of the Redis server | `0` | No |
+| `REDIS_PASSWORD` | The password of the Redis server | | No |
Example
@@ -219,8 +219,8 @@ TELEGRAM_OAUTH_ADMIN_IDS=[123, 321]
## Domains
-| Variable | Description | Default | Required |
-| ------------------ | ------------------------------------------------------------ | ------- | -------- |
+| Variable | Description | Default | Required |
+| ------------------ | ------------------------------------------------------- | ------- | -------- |
| `FRONT_END_DOMAIN` | The domain of the Aura Panel. Used to set CORS headers. | `*` | Yes |
| Variable | Description | Default | Required |
diff --git a/docs/install/panel-security/tinyAuth-for-nginx.md b/docs/install/panel-security/tinyAuth-for-nginx.md
index 0b52b78..3ac4376 100644
--- a/docs/install/panel-security/tinyAuth-for-nginx.md
+++ b/docs/install/panel-security/tinyAuth-for-nginx.md
@@ -17,17 +17,16 @@ tinyauth:
image: ghcr.io/maposia/remnawave-tinyauth:latest
restart: always
ports:
- - '127.0.0.1:3002:3002'
+ - '127.0.0.1:3002:3002'
networks:
- - aura-network
+ - aura-network
environment:
- - PORT=3002
- - APP_URL=https://tinyauth.example.com
- - USERS=your-username-password-hash
- - SECRET=some-random-32-chars-string
-
- # To get USERS and SECRET read below
+ - PORT=3002
+ - APP_URL=https://tinyauth.example.com
+ - USERS=your-username-password-hash
+ - SECRET=some-random-32-chars-string
+ # To get USERS and SECRET read below
```
## Configuring variables
@@ -57,7 +56,7 @@ docker exec -it tinyauth ./tinyauth user create --interactive
Every configuration option that has a `FILE` equivalent (e.g. `USERS` and `USERS_FILE`), then the file can be used instead of the environment variable.
-`USERS=` comma separated list of tinyauth users.*(required)*
+`USERS=` comma separated list of tinyauth users._(required)_
`USERS_FILE=` A file containing a list of tinyauth users.
@@ -67,7 +66,7 @@ All environment variables you can see on official documentation https://tinyauth
To generate the SECRET environment variable using openssl rand -base64 32 | tr -dc 'a-zA-Z0-9' | head -c 32.
-## Configure
+## Configure
Next, you need to configure nginx.conf to protect the required path.
@@ -111,7 +110,7 @@ server {
ssl_trusted_certificate "/etc/nginx/ssl/panel.remnawave.com/fullchain.pem";
location / {
- auth_request /tinyauth;
+ auth_request /tinyauth;
error_page 401 = @tinyauth_login;
proxy_http_version 1.1;
@@ -137,7 +136,7 @@ location /tinyauth {
}
location @tinyauth_login {
- return 302 https://tinyauth.example.com/login?redirect_uri=$scheme://$http_host$request_uri;
+ return 302 https://tinyauth.example.com/login?redirect_uri=$scheme://$http_host$request_uri;
}
#Make sure to replace the http://tinyauth.example.com with your own app URL
@@ -154,7 +153,7 @@ docker compose down && docker compose up -d && docker compose logs -f
## Issuing API-keys
:::info
-
+
You can use Basic base64(username:password) in the `X-Api-Key` header of your requests to the API.
Example: `X-Api-Key: Basic dXNlcm5hbWU6cGFzc3dvcmQ=`
diff --git a/docs/overview/components.md b/docs/overview/components.md
index 86453a5..4fc8648 100644
--- a/docs/overview/components.md
+++ b/docs/overview/components.md
@@ -50,4 +50,3 @@ A simple wrapper for NestJS.
### Internal usage contracts
[](https://www.npmjs.com/package/@localzet/aura-contract)
-
diff --git a/docs/sdk/python-sdk.md b/docs/sdk/python-sdk.md
index 7994699..d43ce90 100644
--- a/docs/sdk/python-sdk.md
+++ b/docs/sdk/python-sdk.md
@@ -126,4 +126,4 @@ async def main():
asyncio.run(main())
```
-