Skip to content

style: format code with Prettier #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
deepsource-autofix wants to merge 1 commit into
base: main
Choose a base branch
from
Open

style: format code with Prettier #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@

<p align="center">
A powerful proxy management tool, built on top of Xray-core, with a focus on simplicity and ease of use.
</div>
</div>
6 changes: 3 additions & 3 deletions docs/awesome-remnawave.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) |
Expand Down
136 changes: 68 additions & 68 deletions docs/guides/warp-outbound-over-wg.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`)
Expand All @@ -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
```
Expand All @@ -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.

---
Expand All @@ -60,19 +63,22 @@ A file named `wgcf-account.toml` will be created.
```bash title="Generate config"
wgcf generate
```

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`

---
Expand All @@ -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"
}
]
}
}
```

Expand All @@ -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"
}
]
```

Expand All @@ -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"
}
```

Expand All @@ -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`.
1 change: 1 addition & 0 deletions docs/install/aura-subscriptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
20 changes: 10 additions & 10 deletions docs/install/environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` |

<details>
<summary>Example</summary>
Expand Down Expand Up @@ -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 |

<details>
<summary>Example</summary>
Expand Down Expand Up @@ -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 |
Expand Down
25 changes: 12 additions & 13 deletions docs/install/panel-security/tinyAuth-for-nginx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand All @@ -67,7 +66,7 @@ All environment variables you can see on official documentation https://tinyauth

To generate the <code>SECRET</code> environment variable using <code>openssl rand -base64 32 | tr -dc 'a-zA-Z0-9' | head -c 32</code>.

## Configure
## Configure

Next, you need to configure nginx.conf to protect the required path.

Expand Down Expand Up @@ -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;
Expand All @@ -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
Expand All @@ -154,7 +153,7 @@ docker compose down && docker compose up -d && docker compose logs -f
## Issuing API-keys

:::info

You can use <code>Basic base64(username:password)</code> in the `X-Api-Key` header of your requests to the API.

Example: `X-Api-Key: Basic dXNlcm5hbWU6cGFzc3dvcmQ=`
Expand Down
1 change: 0 additions & 1 deletion docs/overview/components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,3 @@ A simple wrapper for NestJS.
### Internal usage contracts

[![NPM](https://img.shields.io/npm/v/@localzet/aura-contract?sort=semver&style=for-the-badge&logo=npm&label=NPM)](https://www.npmjs.com/package/@localzet/aura-contract)

2 changes: 1 addition & 1 deletion docs/sdk/python-sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,4 @@ async def main():
asyncio.run(main())
```

</details>
</details>
22 changes: 11 additions & 11 deletions docs/sdk/typescript-sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,17 @@ Always pick and pin the correct version of the SDK to match the version of the A
:::

| Contract Version | Aura Panel Version |
| ---------------- | ----------------------- |
| 0.7.16 | 1.6.7 |
| 0.7.16 | 1.6.6 |
| 0.7.13 | 1.6.5 |
| 0.7.13 | 1.6.4 |
| 0.7.13 | 1.6.3 |
| 0.7.1 | 1.6.2 |
| 0.7.1 | 1.6.1 |
| 0.7.0 | 1.6.0 |
| 0.4.5 | 1.5.7 |
| 0.3.71 | 1.5.0 |
| ---------------- | ------------------ |
| 0.7.16 | 1.6.7 |
| 0.7.16 | 1.6.6 |
| 0.7.13 | 1.6.5 |
| 0.7.13 | 1.6.4 |
| 0.7.13 | 1.6.3 |
| 0.7.1 | 1.6.2 |
| 0.7.1 | 1.6.1 |
| 0.7.0 | 1.6.0 |
| 0.4.5 | 1.5.7 |
| 0.3.71 | 1.5.0 |

## Usage

Expand Down
Loading