From 799b3dcbfedae1982ab61d37a55406f4a755af26 Mon Sep 17 00:00:00 2001 From: Anish Sarkar <104695310+AnishSarkar22@users.noreply.github.com> Date: Sun, 1 Mar 2026 00:43:02 +0530 Subject: [PATCH] docs: add note for Windows users to install WSL before running installation commands --- README.es.md | 3 +++ README.hi.md | 3 +++ README.md | 3 +++ README.pt-BR.md | 3 +++ README.zh-CN.md | 3 +++ surfsense_web/content/docs/docker-installation.mdx | 6 +++++- 6 files changed, 20 insertions(+), 1 deletion(-) diff --git a/README.es.md b/README.es.md index 4795cc9a8..c2f55f366 100644 --- a/README.es.md +++ b/README.es.md @@ -83,6 +83,9 @@ Ejecuta SurfSense en tu propia infraestructura para control total de datos y pri **Requisitos previos:** [Docker](https://docs.docker.com/get-docker/) (con [Docker Compose](https://docs.docker.com/compose/install/)) debe estar instalado y en ejecución. +> [!NOTE] +> Usuarios de Windows: instalen [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) primero y ejecuten el siguiente comando en la terminal de Ubuntu. + ```bash curl -fsSL https://raw.githubusercontent.com/MODSetter/SurfSense/main/docker/scripts/install.sh | bash ``` diff --git a/README.hi.md b/README.hi.md index 3fc8beb71..066e01eb7 100644 --- a/README.hi.md +++ b/README.hi.md @@ -83,6 +83,9 @@ https://github.com/user-attachments/assets/a0a16566-6967-4374-ac51-9b3e07fbecd7 **आवश्यकताएँ:** [Docker](https://docs.docker.com/get-docker/) ([Docker Compose](https://docs.docker.com/compose/install/) सहित) इंस्टॉल और चालू होना चाहिए। +> [!NOTE] +> Windows उपयोगकर्ता: पहले [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) इंस्टॉल करें और नीचे दिया गया कमांड Ubuntu टर्मिनल में चलाएं। + ```bash curl -fsSL https://raw.githubusercontent.com/MODSetter/SurfSense/main/docker/scripts/install.sh | bash ``` diff --git a/README.md b/README.md index 9de1a23bb..7641aa202 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,9 @@ Run SurfSense on your own infrastructure for full data control and privacy. **Prerequisites:** [Docker](https://docs.docker.com/get-docker/) (with [Docker Compose](https://docs.docker.com/compose/install/)) must be installed and running. +> [!NOTE] +> Windows users: install [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) first and run the command below in the Ubuntu terminal. + ```bash curl -fsSL https://raw.githubusercontent.com/MODSetter/SurfSense/main/docker/scripts/install.sh | bash ``` diff --git a/README.pt-BR.md b/README.pt-BR.md index adb102f40..d2e45fe5f 100644 --- a/README.pt-BR.md +++ b/README.pt-BR.md @@ -83,6 +83,9 @@ Execute o SurfSense na sua própria infraestrutura para controle total de dados **Pré-requisitos:** [Docker](https://docs.docker.com/get-docker/) (com [Docker Compose](https://docs.docker.com/compose/install/)) deve estar instalado e em execução. +> [!NOTE] +> Usuários do Windows: instalem o [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) primeiro e executem o comando abaixo no terminal do Ubuntu. + ```bash curl -fsSL https://raw.githubusercontent.com/MODSetter/SurfSense/main/docker/scripts/install.sh | bash ``` diff --git a/README.zh-CN.md b/README.zh-CN.md index 9d5f7d6a4..218252388 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -83,6 +83,9 @@ https://github.com/user-attachments/assets/a0a16566-6967-4374-ac51-9b3e07fbecd7 **前置条件：** 需要安装并运行 [Docker](https://docs.docker.com/get-docker/)（含 [Docker Compose](https://docs.docker.com/compose/install/)）。 +> [!NOTE] +> Windows 用户：请先安装 [WSL](https://learn.microsoft.com/en-us/windows/wsl/install)，然后在 Ubuntu 终端中运行以下命令。 + ```bash curl -fsSL https://raw.githubusercontent.com/MODSetter/SurfSense/main/docker/scripts/install.sh | bash ``` diff --git a/surfsense_web/content/docs/docker-installation.mdx b/surfsense_web/content/docs/docker-installation.mdx index 91d15940a..d6a6bca85 100644 --- a/surfsense_web/content/docs/docker-installation.mdx +++ b/surfsense_web/content/docs/docker-installation.mdx @@ -10,7 +10,11 @@ This guide explains how to run SurfSense using Docker, with options ranging from ### Option 1 — Install Script (recommended) -Downloads the compose files, generates a `SECRET_KEY`, starts all services, and sets up [Watchtower](https://github.com/nicholas-fedor/watchtower) for automatic daily updates: +Downloads the compose files, generates a `SECRET_KEY`, starts all services, and sets up [Watchtower](https://github.com/nicholas-fedor/watchtower) for automatic daily updates. + + +Windows users: install [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) first and run the command below in the Ubuntu terminal. + ```bash curl -fsSL https://raw.githubusercontent.com/MODSetter/SurfSense/main/docker/scripts/install.sh | bash