> ## Documentation Index
> Fetch the complete documentation index at: https://docs.twenty.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Локальная настройка

> Руководство для участников (или любопытных разработчиков), которые хотят запускать Twenty локально.

## Требования

<Tabs>
  <Tab title="Linux и macOS">
    Прежде чем установить и использовать Twenty, убедитесь, что у вас установлено следующее:

    * [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
    * [Node v24.5.0](https://nodejs.org/en/download)
    * [yarn v4](https://yarnpkg.com/getting-started/install)
    * [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md)

    <Warning>
      `npm` не будет работать, используйте `yarn`. Yarn теперь поставляется в комплекте с Node.js, так что устанавливать его отдельно не нужно.
      Нужно лишь выполнить `corepack enable`, чтобы активировать Yarn, если вы еще этого не сделали.
    </Warning>
  </Tab>

  <Tab title="Windows (WSL)">
    1. Установите WSL
       Откройте PowerShell от имени администратора и выполните:

    ```powershell theme={null}
    wsl --install
    ```

    Теперь должно появиться приглашение на перезагрузку компьютера. Если нет, перезагрузите его вручную.

    После перезагрузки откроется окно PowerShell и начнётся установка Ubuntu. Это может занять некоторое время.
    Появится запрос на создание имени пользователя и пароля для вашей установки Ubuntu.

    2. Установите и настройте git

    ```bash theme={null}
    sudo apt-get install git

    git config --global user.name "Your Name"

    git config --global user.email "youremail@domain.com"
    ```

    3. Установите nvm, node.js и yarn

    <Warning>
      Используйте `nvm`, чтобы установить правильную версию `node`. `.nvmrc` гарантирует, что все участники используют одну и ту же версию.
    </Warning>

    ```bash theme={null}
    sudo apt-get install curl

    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
    ```

    Закройте и откройте снова терминал, чтобы использовать nvm. Затем выполните следующие команды.

    ```bash theme={null}

    nvm install # installs recommended node version

    nvm use # use recommended node version

    corepack enable
    ```
  </Tab>
</Tabs>

***

## Шаг 1: Клонирование с помощью Git

Выполните следующую команду в терминале.

<Tabs>
  <Tab title="SSH (Рекомендовано)">
    Если вы еще не настроили SSH ключи, вы можете узнать, как это сделать [здесь](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh).

    ```bash theme={null}
    git clone git@github.com:twentyhq/twenty.git
    ```
  </Tab>

  <Tab title="HTTPS">
    ```bash theme={null}
    git clone https://github.com/twentyhq/twenty.git
    ```
  </Tab>
</Tabs>

## Шаг 2: Перейдите в корень

```bash theme={null}
cd twenty
```

Все команды в следующих шагах следует выполнять из корня проекта.

## Шаг 3: Настройка базы данных PostgreSQL

<Tabs>
  <Tab title="Linux">
    **Опция 1 (предпочтительно):** Чтобы настроить базу данных локально:
    Используйте следующую ссылку для установки PostgreSQL на компьютер с Linux: [Установка PostgreSQL](https://www.postgresql.org/download/linux/)

    ```bash theme={null}
      psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
    ```

    Примечание: Возможно, вам потребуется добавить `sudo -u postgres` к команде перед `psql`, чтобы избежать ошибок с правами.

    **Опция 2:** Если у вас установлен docker:

    ```bash theme={null}
      make -C packages/twenty-docker postgres-on-docker
    ```
  </Tab>

  <Tab title="Mac OS">
    **Опция 1 (предпочтительно):** Чтобы настроить вашу базу данных локально с помощью `brew`:

    ```bash theme={null}
      brew install postgresql@16
      export PATH="/opt/homebrew/opt/postgresql@16/bin:$PATH"
      brew services start postgresql@16
      psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
    ```

    Вы можете проверить, запущен ли сервер PostgreSQL, выполнив:

    ```bash theme={null}
      brew services list
    ```

    Установщик может не создать пользователя `postgres` по умолчанию при установке
    через Homebrew на macOS. Вместо этого он создает роль PostgreSQL, которая совпадает с вашим именем пользователя в MacOS
    например, "john".
    Чтобы проверить и создать пользователя `postgres`, при необходимости выполните следующие шаги:

    ```bash theme={null}
      # Connect to PostgreSQL
      psql postgres
      or
      psql -U $(whoami) -d postgres
    ```

    Оказавшись в приглашении psql (postgres=#), выполните:

    ```bash theme={null}
     # List existing PostgreSQL roles
     \du
    ```

    Вы увидите вывод, похожий на следующий:

    ```bash theme={null}
     Role name | Attributes  | Member of
     -----------+-------------+-----------
     john      | Superuser   | {}
    ```

    Если вы не видите роль `postgres` в списке, перейдите к следующему шагу.
    Создайте роль `postgres` вручную:

    ```bash theme={null}
     CREATE ROLE postgres WITH SUPERUSER LOGIN;
    ```

    Это создает роль суперпользователя с именем `postgres` с доступом для входа.

    ```bash theme={null}
    Role name | Attributes  | Member of
    -----------+-------------+-----------
    postgres  | Superuser   | {}
    john      | Superuser   | {}
    ```

    **Опция 2:** Если у вас установлен docker:

    ```bash theme={null}
      make -C packages/twenty-docker postgres-on-docker
    ```
  </Tab>

  <Tab title="Windows (WSL)">
    Все последующие шаги следует выполнять в терминале WSL (внутри вашей виртуальной машины)

    **Опция 1:** Чтобы настроить PostgreSQL локально:
    Используйте следующую ссылку для установки PostgreSQL на виртуальную машину с Linux: [Установка PostgreSQL](https://www.postgresql.org/download/linux/)

    ```bash theme={null}
      psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
    ```

    Примечание: Возможно, вам потребуется добавить `sudo -u postgres` к команде перед `psql`, чтобы избежать ошибок с правами.

    **Опция 2:** Если у вас установлен docker:
    Запуск Docker на WSL добавляет дополнительный уровень сложности.
    Используйте эту опцию только если вы комфортно себя чувствуете с дополнительными шагами, включая включение [Docker Desktop WSL2](https://docs.docker.com/desktop/wsl).

    ```bash theme={null}
      make -C packages/twenty-docker postgres-on-docker
    ```
  </Tab>
</Tabs>

Теперь вы можете получить доступ к базе данных по адресу `localhost:5432`.

Если вы использовали вариант с Docker выше, учетные данные по умолчанию: пользователь `postgres` и пароль `postgres`. Для нативных установок PostgreSQL используйте учетные данные и роли, настроенные на вашей машине.

## Шаг 4: Настройка базы данных Redis (кэш)

Twenty требует кэша Redis для обеспечения наилучшей производительности.

<Tabs>
  <Tab title="Linux">
    **Опция 1:** Чтобы настроить Redis локально:
    Используйте следующую ссылку для установки Redis на вашу Linux машину: [Установка Redis](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-linux/)

    **Опция 2:** Если у вас установлен docker:

    ```bash theme={null}
      make -C packages/twenty-docker redis-on-docker
    ```
  </Tab>

  <Tab title="Mac OS">
    **Опция 1 (предпочтительно):** Чтобы настроить Redis локально с помощью `brew`:

    ```bash theme={null}
    brew install redis
    ```

    Запустите сервер Redis:

    ```bash theme={null}
    brew services start redis
    ```

    **Опция 2:** Если у вас установлен docker:

    ```bash theme={null}
      make -C packages/twenty-docker redis-on-docker
    ```
  </Tab>

  <Tab title="Windows (WSL)">
    **Опция 1:** Чтобы настроить Redis локально:
    Используйте следующую ссылку для установки Redis на вашу Linux виртуальную машину: [Установка Redis](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-linux/)

    **Опция 2:** Если у вас установлен docker:

    ```bash theme={null}
      make -C packages/twenty-docker redis-on-docker
    ```
  </Tab>
</Tabs>

Если вам нужен графический интерфейс клиента, мы рекомендуем [Redis Insight](https://redis.io/insight/) (доступна бесплатная версия).

## Шаг 5: Настройка переменных окружения

Используйте переменные окружения или файлы `.env` для настройки вашего проекта. Подробнее [здесь](/l/ru/developers/self-host/capabilities/setup).

Скопируйте `.env.example` файлы в `/front` и `/server`:

```bash theme={null}
cp ./packages/twenty-front/.env.example ./packages/twenty-front/.env
cp ./packages/twenty-server/.env.example ./packages/twenty-server/.env
```

<Info>
  **Режим нескольких рабочих пространств:** По умолчанию Twenty работает в режиме одного рабочего пространства, где можно создать только одно рабочее пространство. Чтобы включить поддержку нескольких рабочих пространств (полезно для тестирования функций, основанных на поддоменах), установите `IS_MULTIWORKSPACE_ENABLED=true` в файле `.env` вашего сервера. См. [Режим нескольких рабочих пространств](/l/ru/developers/self-host/capabilities/setup#multi-workspace-mode) для подробностей.
</Info>

## Шаг 6: Установка зависимостей

Чтобы собрать сервер Twenty и добавить данные в вашу базу данных, выполните следующую команду:

```bash theme={null}
yarn
```

Обратите внимание, что `npm` или `pnpm` не будут работать

## Шаг 7: Запуск проекта

<Tabs>
  <Tab title="Linux">
    В зависимости от вашего дистрибутива Linux, сервер Redis может быть запущен автоматически.
    Если нет, проверьте [Руководство по установке Redis](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/) для вашего дистрибутива.
  </Tab>

  <Tab title="Mac OS">
    Redis должен уже работать. Если нет, выполните:

    ```bash theme={null}
    brew services start redis
    ```
  </Tab>

  <Tab title="Windows (WSL)">
    В зависимости от вашей дистрибуции Linux, сервер Redis может быть запущен автоматически.
    Если нет, проверьте [руководство по установке Redis](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/) для вашего дистрибутива.
  </Tab>
</Tabs>

Настройте вашу базу данных с помощью следующей команды:

```bash theme={null}
npx nx database:reset twenty-server
```

Запустите сервер, рабочую программу и сервисы фронтенда:

```bash theme={null}
npx nx start twenty-server
npx nx worker twenty-server
npx nx start twenty-front
```

В качестве альтернативы, вы можете запустить все сервисы сразу:

```bash theme={null}
npx nx start
```

## Шаг 8: Использовать Twenty

**Frontend**

Фронтенд Twenty будет работать на [http://localhost:3001](http://localhost:3001).
Вы можете войти, используя учетную запись демо по умолчанию: `tim@apple.dev` (пароль: `tim@apple.dev`)

**Backend**

* Сервер Twenty будет работать на [http://localhost:3000](http://localhost:3000).
* К GraphQL API можно получить доступ по адресу [http://localhost:3000/graphql](http://localhost:3000/graphql).
* К REST API можно обратиться по адресу [http://localhost:3000/rest](http://localhost:3000/rest).

## Устранение неполадок

Если у вас возникли проблемы, проверьте [Устранение неполадок](/l/ru/developers/self-host/capabilities/troubleshooting) для получения решений.
