From 05e3dec3748b93f3ffb2d7d525d63c9d15840c4d Mon Sep 17 00:00:00 2001 From: Sergey Kutovoy Date: Sun, 23 Mar 2025 22:08:02 +0500 Subject: [PATCH] =?UTF-8?q?docs:=20=D0=BE=D0=B1=D0=BD=D0=BE=D0=B2=D0=B8?= =?UTF-8?q?=D1=82=D1=8C=20=D0=B8=D0=BD=D1=81=D1=82=D1=80=D1=83=D0=BA=D1=86?= =?UTF-8?q?=D0=B8=D0=B8=20=D0=BF=D0=BE=20=D1=83=D1=81=D1=82=D0=B0=D0=BD?= =?UTF-8?q?=D0=BE=D0=B2=D0=BA=D0=B5,=20=D0=B4=D0=BE=D0=B1=D0=B0=D0=B2?= =?UTF-8?q?=D0=B8=D0=B2=20=D1=88=D0=B0=D0=B3=20=D1=83=D1=81=D1=82=D0=B0?= =?UTF-8?q?=D0=BD=D0=BE=D0=B2=D0=BA=D0=B8=20Docker=20=D0=B8=20=D1=81=D0=BA?= =?UTF-8?q?=D0=BE=D1=80=D1=80=D0=B5=D0=BA=D1=82=D0=B8=D1=80=D0=BE=D0=B2?= =?UTF-8?q?=D0=B0=D0=B2=20=D0=BD=D1=83=D0=BC=D0=B5=D1=80=D0=B0=D1=86=D0=B8?= =?UTF-8?q?=D1=8E=20=D1=88=D0=B0=D0=B3=D0=BE=D0=B2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/installation/node/quick-start.md | 20 +++++++++++++------- docs/installation/quick-start.md | 20 +++++++++++++------- 2 files changed, 26 insertions(+), 14 deletions(-) diff --git a/docs/installation/node/quick-start.md b/docs/installation/node/quick-start.md index 826fd6a..1cbf383 100644 --- a/docs/installation/node/quick-start.md +++ b/docs/installation/node/quick-start.md @@ -28,19 +28,25 @@ You can find the list of all environment variables in the [Environment Variables This guide is written for Debian 12, instructions may vary for other distributions. ::: -1. Create separate directory for the project. +1. First of all, you need to install docker. + +```bash +sudo curl -fsSL https://get.docker.com | sh +``` + +2. Create separate directory for the project. ```bash mkdir -p /opt/remnanode && cd /opt/remnanode ``` -2. Create and configure the environment variables. +3. Create and configure the environment variables. ```bash nano .env ``` -3. Add the following content to the .env file: +4. Add the following content to the .env file: :::info SSL_CERT can be found in the main panel under the Nodes tab, after clicking the Create node button. @@ -58,7 +64,7 @@ Do not use port 61001 as APP_PORT - it is a service port! Ensure that APP_PORT is only accessible from your panel IP! ::: -1. Create `docker-compose.yml` file, example below. +5. Create `docker-compose.yml` file, example below. ```yaml title="docker-compose.yml" services: @@ -72,19 +78,19 @@ services: - .env ``` -5. Run containers. +6. Run containers. ```bash docker compose up -d ``` -6. Check the logs. +7. Check the logs. ```bash docker compose logs -f ``` -7. Remnanode is now running. +8. Remnanode is now running. Now we are ready to create a Node in the main panel. diff --git a/docs/installation/quick-start.md b/docs/installation/quick-start.md index 7cf5eeb..1be792d 100644 --- a/docs/installation/quick-start.md +++ b/docs/installation/quick-start.md @@ -46,25 +46,31 @@ Be sure to change the default credentials in the environment variables. This guide written for Ubuntu 22.04, instructions may vary for other distributions. ::: -1. Create separate directory for the project. +1. First of all, you need to install docker. + +```bash +sudo curl -fsSL https://get.docker.com | sh +``` + +2. Create separate directory for the project. ```bash mkdir /opt/remnawave && cd /opt/remnawave ``` -2. Download and configure the environment variables. +3. Download and configure the environment variables. ```bash curl -o .env https://raw.githubusercontent.com/remnawave/backend/refs/heads/main/.env.sample ``` -3. Configure the environment variables. +4. Configure the environment variables. ```bash nano .env ``` -4. Create `docker-compose.yml` file, example below. +5. Create `docker-compose.yml` file, example below. :::danger @@ -151,19 +157,19 @@ volumes: name: remnawave-redis-data ``` -5. Run containers. +6. Run containers. ```bash docker compose up -d ``` -6. Check the logs. +7. Check the logs. ```bash docker compose logs -f ``` -7. Remnawave is now running on `http://127.0.0.1:3000`. +8. Remnawave is now running on `http://127.0.0.1:3000`. Now we are ready to move on the Reverse Proxy installation.