docs: streamline environment variable documentation and enhance quick start guide with Redis integration

This commit is contained in:
kastov
2025-03-13 23:48:26 +03:00
parent dd2666f642
commit d5d536d7e4
4 changed files with 43 additions and 91 deletions

View File

@@ -106,21 +106,6 @@ Example: `FRONT_END_DOMAIN=panel.example.com`
FRONT_END_DOMAIN=*
```
### SUBSCRIPTION INFO
This values will be passed to response headers in subscription response.
A lot of clients relay on these headers.
For example, `SUB_UPDATE_INTERVAL` is used to update subscription in Streisand, Clash Verge and other clients.
```bash
SUB_SUPPORT_URL=https://support.example.com
SUB_PROFILE_TITLE=Subscription Profile
SUB_UPDATE_INTERVAL=12
SUB_WEBPAGE_URL=https://example.com
```
### SUBSCRIPTION PUBLIC DOMAIN
Default path for subscription URL is `/api/sub/<sub uuid>`.
@@ -133,33 +118,6 @@ Must be a valid domain, without http/https. Do not place `/` to end of domain/pa
SUB_PUBLIC_DOMAIN=example.com/api/sub
```
### User statuses
It can be used to customize user statuses remarks, which will see user if their status in not ACTIVE.
Must be an array of strings, each string is a remark.
```bash
EXPIRED_USER_REMARKS=["⚠️ Subscription expired","Contact support"]
DISABLED_USER_REMARKS=["❌ Subscription disabled","Contact support"]
LIMITED_USER_REMARKS=["🔴 Subscription limited","Contact support"]
```
### Admin credentials
Be sure to change the credentials.
:::danger
Do not use default credentials in production.
:::
```bash
SUPERADMIN_USERNAME=change_me
SUPERADMIN_PASSWORD=change_me
```
### Docs
Enable docs.
@@ -218,7 +176,7 @@ global:
scrape_configs:
- job_name: 'remnawave'
scheme: http
metrics_path: /api/metrics
metrics_path: /metrics
static_configs:
- targets: ['remnawave:3001']
scrape_interval: 30s
@@ -268,27 +226,3 @@ POSTGRES_USER=username
POSTGRES_PASSWORD=password
POSTGRES_DB=database_name
```
## Node {#node}
### APP_PORT
Port for the node inside Docker container.
```bash
APP_PORT=3000
```
### SSL_CERT
It can be retrieved from the main panel.
:::warning
Do not share your certificate with anyone.
:::
```bash
SSL_CERT=PUT CERTIFICATE HERE
```

View File

@@ -3,11 +3,11 @@ sidebar_position: 3
slug: /installation/node/env
title: Env variables
---
## Node {#node}
### APP_PORT
:::caution
Ensure that APP_PORT is only accessible from your panel IP!
:::
@@ -27,5 +27,5 @@ Do not share your certificate with anyone.
:::
```bash
SSL_CERT=PUT CERTIFICATE HERE
```
SSL_CERT=PUT_CERTIFICATE_HERE
```

View File

@@ -31,7 +31,7 @@ This guide is written for Debian 12, instructions may vary for other distributio
1. Create separate directory for the project.
```bash
mkdir remnanode && cd remnanode
mkdir -p ~/remnanode && cd ~/remnanode
```
2. Create and configure the environment variables.
@@ -39,42 +39,36 @@ mkdir remnanode && cd remnanode
```bash
nano .env
```
3. Add the following content to the .env file:
:::info
APP_PORT and SSL_CERT can be found in the main panel under the Nodes tab, after clicking the Create node button.
SSL_CERT can be found in the main panel under the Nodes tab, after clicking the Create node button.
APP_PORT can be customized, make sure it's not used by other services.
:::
```bash title=".env"
APP_PORT=2222
SSL_CERT="-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyAcjyADzLmB21Hz6NnnJ
L8Zoeo0iiPHS/rL/2xI/laBR2aEC58ippctZGU9akcD+hAPS9KsuRBDsSSnVpd1A
f+WiCCKouQCc7C9vbtJx4q6Dh7XThomBHLF5Xnlsa3z+ZES3uMHsSZy5IHdBdJ26
3CCT/Po+GVlc1fCMPHZh9sgZPPNXu22puqVFI1XIG795zzrclTsWsJiIN8VjC7bO
HisC7aBqHIByld6dE7TVDTrtlMJFwZXx1J5+AM19pwcsGuuakYRdgbavt/P30wEN
6+TjSSfV/x4Lm5Tdpqc2DHAgsaEEbxoTtcMG7WCqySLYiJZyEHe0P2k0pLTJjBcz
XQIDAQAB
-----END PUBLIC KEY-----"
SSL_CERT=CERT_FROM_MAIN_PANEL
```
:::caution
Ensure that APP_PORT is only accessible from your panel IP!
:::
4. Create `docker-compose.yml` file, example below.
1. Create `docker-compose.yml` file, example below.
```yaml title="docker-compose.yml"
services:
remnanode:
container_name: remnanode
hostname: remnanode
image: remnawave/node:latest
env_file:
- .env
network_mode: host
remnanode:
container_name: remnanode
hostname: remnanode
image: remnawave/node:latest
restart: always
network_mode: host
env_file:
- .env
```
5. Run containers.
@@ -91,4 +85,4 @@ docker compose logs -f
7. Remnanode is now running.
Now we are ready to create a Node in the main panel.
Now we are ready to create a Node in the main panel.

View File

@@ -113,6 +113,26 @@ services:
- .env
networks:
- remnawave-network
depends_on:
remnawave-db:
condition: service_healthy
remnawave-redis:
condition: service_healthy
remnawave-redis:
image: valkey/valkey:8.0.2-alpine
container_name: remnawave-redis
hostname: remnawave-redis
restart: always
networks:
- remnawave-network
volumes:
- remnawave-redis-data:/data
healthcheck:
test: ['CMD', 'valkey-cli', 'ping']
interval: 3s
timeout: 10s
retries: 3
networks:
remnawave-network:
@@ -125,6 +145,10 @@ volumes:
driver: local
external: false
name: remnawave-db-data
remnawave-redis-data:
driver: local
external: false
name: remnawave-redis-data
```
5. Run containers.