chore: release v2.2.6

Merge pull request #112 from remnawave/dev

Author: kastov

.env.sample

@@ -5,7 +5,7 @@ METRICS_PORT=3001
 ### API ###
 # Possible values: max (start instances on all cores), number (start instances on number of cores), -1 (start instances on all cores - 1)
 # !!! Do not set this value more than physical cores count in your machine !!!
-# Review documentation: https://remna.st/docs/install/environment-variables#scaling-api
+# Review documentation: https://docs.rw/docs/install/environment-variables#scaling-api
 API_INSTANCES=1
 
 ### DATABASE ###
@@ -41,7 +41,7 @@ FRONT_END_DOMAIN=*
 ### SUBSCRIPTION PUBLIC DOMAIN ###
 ### DOMAIN, WITHOUT HTTP/HTTPS, DO NOT ADD / AT THE END ###
 ### Used in "profile-web-page-url" response header and in UI/API ###
-### Review documentation: https://remna.st/docs/install/environment-variables#domains
+### Review documentation: https://docs.rw/docs/install/environment-variables#domains
 SUB_PUBLIC_DOMAIN=panel.domain.com/api/sub
 
 ### If CUSTOM_SUB_PREFIX is set in @remnawave/subscription-page, append the same path to SUB_PUBLIC_DOMAIN. Example: SUB_PUBLIC_DOMAIN=sub-page.example.com/sub
@@ -56,17 +56,19 @@ IS_DOCS_ENABLED=false
 METRICS_USER=admin
 METRICS_PASS=admin
 
-### WEBHOOK ###
+# Webhook configuration
+# Enable webhook notifications (true/false, defaults to false if not set or empty)
 WEBHOOK_ENABLED=false
-### Can be https:// or http://
-WEBHOOK_URL=https://webhook.site/1234567890
+# Webhook URL to send notifications to (can specify multiple URLs separated by commas if needed)
+# Only http:// or https:// are allowed.
+WEBHOOK_URL=https://your-webhook-url.com/endpoint
 ### This secret is used to sign the webhook payload, must be exact 64 characters. Only a-z, 0-9, A-Z are allowed.
 WEBHOOK_SECRET_HEADER=vsmu67Kmg6R8FjIOF1WUY8LWBHie4scdEqrfsKmyf4IAf8dY3nFS0wwYHkhh6ZvQ
 
 ### HWID DEVICE DETECTION AND LIMITATION ###
 # Don't enable this if you don't know what you are doing.
 # Review documentation before enabling this feature.
-# https://remna.st/docs/features/hwid-device-limit/
+# https://docs.rw/docs/features/hwid-device-limit/
 HWID_DEVICE_LIMIT_ENABLED=false
 
 

DEVELOPMENT.md

@@ -0,0 +1,49 @@
+1. Launch the database and redis containers:
+
+```bash
+docker compose -f docker-compose-db-local.yml up -d
+```
+
+2. Install dependencies:
+
+```bash
+npm install
+```
+
+3. Migrate the database:
+
+```bash
+npm run migrate:deploy
+```
+
+4. Generate types:
+
+```bash
+npm run migrate:generate
+```
+
+5. Seed the database:
+
+```bash
+npm run seed:dev
+```
+
+6. Running dev mode (if you run multiple instances, make sure to wait before starting the next instance):
+
+- API:
+
+```bash
+npm run dev:api
+```
+
+- Worker:
+
+```bash
+npm run dev:worker
+```
+
+- Scheduler:
+
+```bash
+npm run dev:scheduler
+```

README.md

@@ -2,7 +2,7 @@
 
 Backend for Remnawave Panel.
 
-Learn more about Remnawave Panel [here](https://remna.st/).
+Learn more about Remnawave Panel [here](https://docs.rw/).
 
 # Contributors
 

libs/contract/commands/external-squads/update-external-squad.command.ts

@@ -2,6 +2,7 @@ import { z } from 'zod';
 
 import {
     ExternalSquadHostOverridesSchema,
+    ExternalSquadResponseHeadersSchema,
     ExternalSquadSchema,
     ExternalSquadSubscriptionSettingsSchema,
 } from '../../models';
@@ -39,6 +40,7 @@ export namespace UpdateExternalSquadCommand {
             .optional(),
         subscriptionSettings: ExternalSquadSubscriptionSettingsSchema.optional(),
         hostOverrides: ExternalSquadHostOverridesSchema.optional(),
+        responseHeaders: ExternalSquadResponseHeadersSchema.optional(),
     });
 
     export type Request = z.infer<typeof RequestSchema>;

libs/contract/models/external-squad.schema.ts

@@ -3,6 +3,7 @@ import { z } from 'zod';
 import {
     ExternalSquadSubscriptionSettingsSchema,
     ExternalSquadHostOverridesSchema,
+    ExternalSquadResponseHeadersSchema,
 } from './external-squads';
 import { SUBSCRIPTION_TEMPLATE_TYPE } from '../constants';
 
@@ -22,6 +23,7 @@ export const ExternalSquadSchema = z.object({
     ),
     subscriptionSettings: z.nullable(ExternalSquadSubscriptionSettingsSchema),
     hostOverrides: z.nullable(ExternalSquadHostOverridesSchema),
+    responseHeaders: ExternalSquadResponseHeadersSchema,
 
     createdAt: z
         .string()

libs/contract/models/external-squads/external-squad-response-headers.schema.ts

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+
+export const ExternalSquadResponseHeadersSchema = z.nullable(z.record(z.string(), z.string()));

libs/contract/models/external-squads/index.ts

@@ -1,2 +1,3 @@
 export * from './external-squad-host-overrides.schema';
+export * from './external-squad-response-headers.schema';
 export * from './external-squad-subscription-settings.schema';

libs/contract/models/remnawave-settings/oauth2-settings.schema.ts

@@ -23,7 +23,7 @@ export const Oauth2SettingsSchema = z.object({
                     return false;
                 },
                 {
-                    message: 'Must be a valid fully qualified domain name (FQDN), e.g. "remna.st"',
+                    message: 'Must be a valid fully qualified domain name (FQDN), e.g. "docs.rw"',
                 },
             ),
         ),

libs/contract/models/remnawave-settings/passkey-settings.schema.ts

@@ -17,7 +17,7 @@ export const PasskeySettingsSchema = z.object({
                 return false;
             },
             {
-                message: 'Must be a valid fully qualified domain name (FQDN), e.g. "remna.st"',
+                message: 'Must be a valid fully qualified domain name (FQDN), e.g. "docs.rw"',
             },
         ),
     ),
@@ -35,7 +35,7 @@ export const PasskeySettingsSchema = z.object({
                 return false;
             },
             {
-                message: 'Must be a valid plain URL, e.g. "https://remna.st".',
+                message: 'Must be a valid plain URL, e.g. "https://docs.rw".',
             },
         ),
     ),

libs/contract/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remnawave/backend-contract",
-  "version": "2.2.32",
+  "version": "2.2.34",
   "public": true,
   "license": "AGPL-3.0-only",
   "description": "A contract library for Remnawave Backend. It can be used in backend and frontend.",