VPN/panel
1
0
Fork 0
mirror of https://github.com/remnawave/panel.git synced 2026-03-30 00:54:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix typos and grammar; apply american english style best practices in /docs

Browse Source
This commit is contained in:
zzzuckerhhhalo
2025-08-11 13:58:13 +03:00
parent 61fe3b8a7f
commit 98124d7026
6 changed files with 80 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
docs/install/remnawave-node.md
View File

@@ -7,48 +7,48 @@ import InstallDocker from '/docs/partials/\_install_docker.md';
# Remnawave Node
Remnawave Node is a lightweight container with included Xray-core.
Remnawave Node is a lightweight container that includes Xray-core.
:::note
Remnawave Panel is not contains Xray-core inside, so you need to install Remnawave Node on a separate server in order to fully use Remnawave.
Remnawave Panel does not include Xray-core, so you need to install Remnawave Node on a separate server to use all features of Remnawave.
:::
<InstallDocker />
## Step 1 - Creating project directory
## Step 1 — Create project directory
```bash title="Creating project directory"
```bash title="Create project directory"
mkdir /opt/remnanode && cd /opt/remnanode
```
## Step 2 - Configure the .env file
## Step 2 — Configure the .env file
```bash title="Creating .env file"
```bash title="Create .env file"
nano .env
```
:::tip
`SSL_CERT` can be found in the main panel under the Nodes tab, Management page, after clicking the **Create new node** button. `APP_PORT` can be customized, make sure it's not being used by other services.
`SSL_CERT` value can be obtained from the Panel under Nodes → Management → Create new node (`+` button). Copy button in `Important note` will add `SSL_CERT=` to your clipboard.
`APP_PORT` can be customized. Make sure it's not being used by other services.
:::
```bash title=".env file content"
```bash title="Example of .env file content"
APP_PORT=2222
SSL_CERT=CERT_FROM_MAIN_PANEL
```
:::caution
The line copied from the panel already contains `SSL_CERT=` — just paste it directly from the clipboard.
The line copied from the Panel already contains `SSL_CERT=` — just paste it directly from the clipboard.
:::
## Step 3 - Create docker-compose.yml file
## Step 3 — Create docker-compose.yml file
```bash title="Creating docker-compose.yml file"
```bash title="Create docker-compose.yml file"
nano docker-compose.yml
```
Paste the following content into the file:
Paste this content and save:
```yaml title="docker-compose.yml file content"
services:
@@ -62,7 +62,7 @@ services:
- .env
```
## Step 4 - Start the containers
## Step 4 — Start the containers
Start the containers by running the following command:
@@ -76,15 +76,14 @@ docker compose up -d && docker compose logs -f -t
:::danger Important note
1. This guide contains only an example and does not reflect the real names of the `*-zapret.dat` files and the `:zapret` categories used in them. In reality, these things will be different.
2. Setting up routing on the server (node) will not allow you to send connections to DIRECT on clients. This is server routing, necessary for blocking or setting routes between servers. To manage client traffic, client routing is used.
1. This example uses placeholder names for the `*-zapret.dat` files and the `:zapret` categories. Actual file names and categories will be different.
2. Routing configured on the server (node) controls server-side traffic and will not affect client DIRECT connections. To manage client traffic routing, configure routing on the client side.
:::
You can mount additional geosite and geoip files into the `/usr/local/share/xray/` directory in the container.
You can add additional geosite and geoip files by mounting them into the `/usr/local/share/xray/` directory inside the container.
:::caution
Do not mount the entire folder. Otherwise, you will overwrite the default Xray geosite and geoip files. Mount each file individually.
Do not mount the entire folder, this will overwrite the default Xray geosite and geoip files. Instead, mount each file separately.
:::
Add the following to the `docker-compose.yml` file:
@@ -107,7 +106,7 @@ services:
- './ip-zapret.dat:/usr/local/share/xray/ip-zapret.dat'
```
Usage in xray config:
Usage in Xray config:
```json
"routing": {
@@ -138,9 +137,9 @@ Usage in xray config:
}
```
### Log from Node
### Logs from Node
You can access logs from the node by mounting them to your host's file system.
You can access Node logs by mounting the log directory to your host file system.
:::caution
You **must** set up log rotation, otherwise the logs will fill up your disk!
@@ -164,7 +163,7 @@ services:
- '/var/log/remnanode:/var/log/remnanode'
```
Usage in xray config:
Usage in Xray config:
```json
"log": {
@@ -174,7 +173,7 @@ Usage in xray config:
}
```
On the server where the node is hosted, create the folder `/var/log/remnanode`:
On the server hosting the node, create the folder `/var/log/remnanode` by running:
```bash
mkdir -p /var/log/remnanode
@@ -205,7 +204,7 @@ Paste the following logrotate configuration for RemnaNode:
}
```
Run logrotate manually to test:
Run the logrotate to test the configuration:
```bash
logrotate -vf /etc/logrotate.d/remnanode
@@ -214,15 +213,15 @@ logrotate -vf /etc/logrotate.d/remnanode
### XRay SSL cert for Node
:::danger
This item is necessary for you in case of implementation of TLS transport, for example "VLESS-Vision-TLS". In case of Reality, you do not need it.
This step is necessary if you implement TLS transport, for example, 'VLESS-Vision-TLS'. For Reality transport, this is not required.
:::
If you’re using certificates for your XRay configuration, you need to mount them into the panel.
If you’re using certificates for your Xray configuration, you need to mount them into the panel.
:::info
Mount the folder via Docker volumes, and in the config refer to the internal path.
Inside the container there’s a dedicated (empty) folder for certs:
/var/lib/remnawave/configs/xray/ssl/
Mount the folder using Docker volumes, and refer to the internal path in your configuration.
Inside the container, there is a dedicated (empty) directory for certificates:
`/var/lib/remnawave/configs/xray/ssl/`
:::
Add the following to the `docker-compose.yml` file:
@@ -251,10 +250,10 @@ remnawave:
```
:::info
When the panel pushes the config to the node, it will automatically read the mounted files and send the certs to the node.
When the Panel pushes the configuration to the Node, it will automatically read the mounted files and send them to the Node.
:::
Usage in XRay config:
Usage in Xray config:
```json
"certificates": [

42
docs/install/remnawave-panel.md
View File

@@ -7,17 +7,17 @@ import InstallDocker from '/docs/partials/\_install_docker.md';
# Remnawave Panel
Remnawave Panel is the main component of Remnawave. It will be used to manage your users, nodes, subscriptions and more.
Remnawave Panel is the main component of Remnawave. It is used to manage users, nodes, subscriptions, and more.
<InstallDocker />
## Step 1 - Download vital files
## Step 1 – Download required files
```bash title="Creating project directory"
```bash title="Create project directory"
mkdir /opt/remnawave && cd /opt/remnawave
```
Download [`docker-compose.yml`][compose-file] and [`.env.sample`][env-file] by running the following commands:
Download [`docker-compose.yml`][compose-file] and [`.env.sample`][env-file] by running these commands:
```bash title="Get docker-compose.yml file"
curl -o docker-compose.yml https://raw.githubusercontent.com/remnawave/backend/refs/heads/main/docker-compose-prod.yml
@@ -27,42 +27,42 @@ curl -o docker-compose.yml https://raw.githubusercontent.com/remnawave/backend/r
curl -o .env https://raw.githubusercontent.com/remnawave/backend/refs/heads/main/.env.sample
```
## Step 2 - Configure the .env file
## Step 2 – Configure the .env file
`JWT_AUTH_SECRET` and `JWT_API_TOKENS_SECRET` are used for authentication or other purposes.
`JWT_AUTH_SECRET` and `JWT_API_TOKENS_SECRET` are used for authentication and related security functions.
Generate secret key by running the following command:
Generate secret key by running the following commands:
```bash title="Generating secure keys"
```bash title="Generate secure keys"
sed -i "s/^JWT_AUTH_SECRET=.*/JWT_AUTH_SECRET=$(openssl rand -hex 64)/" .env && sed -i "s/^JWT_API_TOKENS_SECRET=.*/JWT_API_TOKENS_SECRET=$(openssl rand -hex 64)/" .env
```
```bash title="Generating passwords"
```bash title="Generate passwords"
sed -i "s/^METRICS_PASS=.*/METRICS_PASS=$(openssl rand -hex 64)/" .env && sed -i "s/^WEBHOOK_SECRET_HEADER=.*/WEBHOOK_SECRET_HEADER=$(openssl rand -hex 64)/" .env
```
Also, it is better to change the default Postgres password.
```bash title="Changing Postgres password"
It is strongly recommended to change the default Postgres password.
```bash title="Change Postgres password"
pw=$(openssl rand -hex 24) && sed -i "s/^POSTGRES_PASSWORD=.*/POSTGRES_PASSWORD=$pw/" .env && sed -i "s|^\(DATABASE_URL=\"postgresql://postgres:\)[^\@]*\(@.*\)|\1$pw\2|" .env
```
Now, open the `.env` file, you need to change the following variables:
Now, open the `.env` file and update the following variables:
- `FRONT_END_DOMAIN`
- `SUB_PUBLIC_DOMAIN`
`FRONT_END_DOMAIN` is the domain name under which the panel will be accessible. Just use your domain name here.
`FRONT_END_DOMAIN` is the domain name where the panel will be accessible. Enter your domain name here.
Example: `panel.yourdomain.com`.
`SUB_PUBLIC_DOMAIN` – for now just enter your panel domain and add `/api/sub` to the end of it.
`SUB_PUBLIC_DOMAIN` – for now, just enter your panel domain and add `/api/sub` to the end.
Example: `panel.yourdomain.com/api/sub`.
:::tip Changing environment variables
:::tip More about environment variables
You can find more information about the environment variables in the [Environment Variables](/docs/install/environment-variables.md) page.
:::
## Step 3 - Start the containers
## Step 3 – Start the containers
Start the containers by running the following command:
@@ -70,19 +70,19 @@ Start the containers by running the following command:
docker compose up -d && docker compose logs -f -t
```
Wait a few seconds and you will see the following output
After a few seconds, you should see output similar to this:
![Remnawave Panel](/install/panel_up.webp)
## Next Steps
:::danger
Reverse proxy is required to properly run Remnawave Panel.
A reverse proxy is required to run Remnawave Panel properly.
Do not expose the services to the public internet; use only `127.0.0.1` for Remnawave services.
Do not expose the services to the public internet. Use only `127.0.0.1` for Remnawave services.
:::
Now we are ready to move on to Reverse Proxy installation.
You can now proceed to reverse proxy installation.
<Button label="Reverse Proxy Installation" link="/docs/install/reverse-proxies/" variant="secondary" size="md" outline style={{ marginBottom: '1rem' }} />

20
docs/install/requirements.md
View File

@@ -4,20 +4,22 @@ sidebar_position: 1
# Requirements
**Remnawave Panel** is the main component of Remnawave. It will be used to manage your users, nodes and all the other stuff.
**Remnawave Node** is a lightweight container with included Xray-core.
This page lists the hardware and software requirements for running Remnawave.
**Remnawave Panel** is the main component of Remnawave. It is used to manage users, nodes, and other elements.
**Remnawave Node** is a lightweight container that includes Xray-core.
## Remnawave Panel
### Hardware
- **OS**: Recommended **Ubuntu** or **Debian**.
- **RAM**: Minimum 2GB, recommended 4GB.
- **RAM**: Minimum 2 GB, recommended 4 GB.
- **CPU**: Minimum 2 cores, recommended 4 cores.
- **Storage**: Minimum and recommended 20GB.
- **Storage**: 20 GB, minimum and recommended.
:::tip
Remnawave can run with lower specs, but it's not recommended. Some of background processes can be resource-intensive.
Remnawave can run with lower specifications, but this is not recommended. Some background processes can be resource-intensive.
:::
## Remnawave Node
@@ -25,19 +27,19 @@ Remnawave can run with lower specs, but it's not recommended. Some of background
### Hardware
- **OS**: Recommended **Ubuntu** or **Debian**.
- **RAM**: Minimum 1GB.
- **RAM**: Minimum 1 GB.
- **CPU**: Minimum 1 core.
:::tip
Remnawave Node by itself does not require much resources, but Xray-core can consume a lot of CPU and RAM under heavy load.
Remnawave Node itself does not require many resources; however, Xray-core can consume significant CPU and RAM under heavy load.
:::
## Software
Remnawave Panel and Remnawave Node requires [**Docker**](https://docs.docker.com/get-started/get-docker/) with the **Docker Compose plugin**.
Remnawave Panel and Remnawave Node require [**Docker**](https://docs.docker.com/get-started/get-docker/) with the **Docker Compose plugin**.
<details>
<summary>Quick install</summary>
<summary>Install Docker using official script</summary>
```bash
sudo curl -fsSL https://get.docker.com | sh

10
docs/overview/components.md
View File

@@ -5,20 +5,20 @@ title: Components
### Panel
Main entrypoint for Remnawave, containts this documentation and releases.
Main entry point for Remnawave. Contains this documentation and releases.
### Backend
[![GitHub Tag](https://img.shields.io/github/v/tag/remnawave/backend?sort=semver&style=for-the-badge&logo=github&label=Backend)](https://github.com/remnawave/backend)
[![Docker Hub](https://img.shields.io/docker/v/remnawave/backend?sort=semver&style=for-the-badge&logo=github&label=Docker)](https://hub.docker.com/r/remnawave/backend)
Backend for Remnawave, written in NestJS.
Backend for Remnawave, built with NestJS.
### Frontend
[![GitHub Tag](https://img.shields.io/github/v/tag/remnawave/frontend?sort=semver&style=for-the-badge&logo=github&label=Frontend)](https://github.com/remnawave/frontend)
Frontend for Remnawave, written in React.
Frontend for Remnawave, built with React.
### Node
@@ -32,13 +32,13 @@ Node for Remnawave, written in TypeScript.
[![NPM](https://img.shields.io/npm/v/@remnawave/xtls-sdk?sort=semver&style=for-the-badge&logo=npm&label=NPM)](https://www.npmjs.com/package/@remnawave/xtls-sdk)
[![GitHub Tag](https://img.shields.io/github/v/tag/remnawave/xtls-sdk?sort=semver&style=for-the-badge&logo=github&label=GitHub)](https://github.com/remnawave/xtls-sdk)
A TypeScript/JavaScript SDK for interacting with XTLS/Xray-core - a powerful network proxy tool that supports protocols like VLESS, XTLS, REALITY and more. Built on top of the official Xray-core project.
A TypeScript/JavaScript SDK for interacting with XTLS/Xray-core - a powerful network proxy tool that supports protocols such as VLESS, XTLS, REALITY, and more. Built on top of the official Xray-core project.
Key features:
- Full TypeScript support
- Wrapper around Xray-core functionality
- Supports core XTLS/Xray features and protocols
- Supports core XTLS/Xray features and protocols.
### XTLS-SDK-NestJS

4
docs/overview/introduction.md
View File

@@ -16,6 +16,6 @@ hide_table_of_contents: true
<Button label="Check out latest release" link="https://github.com/remnawave/panel" variant="secondary" size="md" outline style={{ marginBottom: '1rem' }} />
Remnawave is a powerful proxy managment tool, built on top of [Xray-core](https://github.com/XTLS/Xray-core), with a focus on simplicity and ease of use.
Remnawave is a powerful proxy management tool, built on top of [Xray-core](https://github.com/XTLS/Xray-core), with a focus on simplicity and ease of use.
Backend, Node and Frontend are fully written in TypeScript with [NestJS](https://github.com/nestjs/nest) and [React](https://github.com/facebook/react) with [MantineUI](https://github.com/mantinedev/mantine) respectively.
The Backend, Node, and Frontend are written entirely in TypeScript using [NestJS](https://github.com/nestjs/nest) and [React](https://github.com/facebook/react) with [Mantine UI](https://github.com/mantinedev/mantine) respectively.

20
docs/overview/quick-start.md
View File

@@ -7,8 +7,8 @@ import DocCard from '@theme/DocCard';
# Quick start
Here is a quick and brief guide to install Remnawave Panel and Remnawave Node.
Here is a quick guide to installing Remnawave Panel and Remnawave Node.
## Requirements
Check the [requirements page](/docs/install/requirements) to get started.
@@ -29,32 +29,32 @@ First, install the Remnawave Panel.
### Step 2: Reverse Proxy
Configure a reverse proxy to access the Remnawave Panel.
Configure a reverse proxy so you can access the Remnawave Panel.
```mdx-code-block
<DocCard
item={{ type: 'link', label: 'Reverse Proxy', description: 'Select and configure reverse proxy', href: '/docs/install/reverse-proxies' }}
item={{ type: 'link', label: 'Reverse Proxy', description: 'Select and configure a reverse proxy', href: '/docs/install/reverse-proxies' }}
/>
```
### Step 3: Subscription-Page (optional)
### Step 3: Subscription Page (optional)
Install a subscription page to secure panel domain and create public subscription page.
Install a subscription page to secure the panel domain and create a public subscription page.
```mdx-code-block
<DocCard
item={{ type: 'link', label: 'Subscription-Page', description: 'Secure panel domain and create public subscription page', href: '/docs/install/remnawave-subscription-page' }}
item={{ type: 'link', label: 'Subscription-Page', description: 'Secure the panel domain and create a public subscription page', href: '/docs/install/remnawave-subscription-page' }}
/>
```
### Step 4: Remnawave Node
Install Remnawave Node to the same server (_not recommended_) or different server.
Install Remnawave Node on the same server (_not recommended_) or on a different server.
```mdx-code-block