Saltcorn

npm config set prefix ~/.local
npm install -g @saltcorn/cli
export SQLITE_FILEPATH=~/saltcorn.sqlite
~/.local/bin/saltcorn reset-schema -f
~/.local/bin/saltcorn serve

wget -qO - https://deb.nodesource.com/setup_22.x | sudo bash -
sudo apt-get install -qqy nodejs
npx saltcorn-install -y

wget -qO - https://deb.nodesource.com/setup_22.x | sudo -E bash -
sudo apt-get install -y nodejs libpq-dev build-essential python-is-python3
```## Установка из NPM пакетов

Инструкции были протестированы на Ubuntu 20.04 на виртуальной машине с 1 ГБ оперативной памяти.

TL;DR: `npm install -g @saltcorn/cli && saltcorn setup`

### Установка Node.js и npm

Для последней версии (v22) Node.js:

Вы также можете установить любую версию Node.js от 18 до 24.

### Установка Saltcorn

`npm install -g @saltcorn/cli`

Если установка не удалась, вы можете указать npm игнорировать файловые разрешения во время компиляции:

`npm install -g @saltcorn/cli --unsafe-perm`

В некоторых случаях указанные выше команды не устанавливают библиотеку `sd-notify` (которая полезна для интеграции с systemd), несмотря на то, что она установлена. Вы можете исправить это, установив её позже:

`npm install -g sd-notify`

### Настройка (автоматическая)

Если вы являетесь `root`, создайте пользователя с правами sudo и переключитесь на этого пользователя:

затем выполните

`saltcorn setup` и следуйте инструкциям.

### Настройка (ручная)

ЗАМЕЧАНИЕ: эта инструкция несколько устарела; см. https://wiki.saltcorn.com/view/ShowPage?title=Install%20on%20Ubuntu, в частности последний раздел.

Пропустите этот раздел, если вы выполнили `saltcorn setup` или `npx saltcorn-install`

1. Установите PostgreSQL: `sudo apt install postgresql postgresql-client`
2. Или,

   - Создайте JSON-файл `.saltcorn` в вашей директории конфигурации XDG (на Ubuntu это обычно \$HOME/.config) со следующими значениями:     - `host`: адрес сервера PostgreSQL
     - `port`: порт сервера PostgreSQL
     - `database`: имя базы данных PostgreSQL
     - `user`: имя пользователя PostgreSQL
     - `password`: пароль пользователя PostgreSQL
     - `sslmode`: режим SSL PostgreSQL [SSL Mode](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-SSLMODE)
     - `sslcert`: сертификат SSL PostgreSQL [SSL Certificate](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-SSLCERT)
     - `sslkey`: ключ SSL PostgreSQL [SSL Key](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-SSLKEY)
     - `sslrootcert`: корневой сертификат SSL PostgreSQL [SSL Root Certificate](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-SSLROOTCERT)
     - `session_secret`: секретная сессия Saltcorn
     - `multi_tenant`: запуск в многопользовательском режиме (true/false)

Например:

```json
{
   "host":"localhost",
   "port":5432,
   "database":"saltcorn",
   "user":"tomn",
   "password":"dgg2342vfB",
   "session_secret":"hrh64b45b3",
   "multi_tenant":true
}

запустите:

Это может быть в другом месте в системах, отличных от Debian, например, в `/etc/systemd/system`.

Чтобы разрешить пользователю `saltcorn` открывать порт 80, вам нужно разрешить это node.js, запустив:

#### SSL-сертификат

Используйте [Let's Encrypt](https://letsencrypt.org/) или [Cloudflare](https://www.cloudflare.com/ssl/) для получения бесплатного SSL-сертификата (для https).

## Установка из исходного кода (для разработчиков Saltcorn)

### Установка node и npm на Ubuntu

`sudo apt install nodejs npm libpq-dev`

позволяет получить рабочую версию. Для более новой версии (v22) Node.js:

### Подготовка Node

предполагая, что вы склонировали этот репозиторий в \$HOME/saltcorn (в противном случае скорректируйте ПУТЬ)

### Установка пакетов

запустите

для установки всего. Если установка прошла успешно, вы должны теперь иметь возможность запустить `saltcorn` в вашей оболочке.

## Пакеты

- [@saltcorn-cli](https://github.com/saltcorn/saltcorn/tree/master/packages/saltcorn-cli): команда командной строки
```## Советы по развертыванию

- Если ваш сервер Saltcorn работает за прокси-сервером обратного проксирования, таким как Nginx, обратитесь к [документации Socket.io для прокси-серверов обратного проксирования](https://socket.io/docs/v3/reverse-proxy/#nginx). Эта конфигурация необходима для Socket.io, который обеспечивает функциональность чата, просмотра логов и потокового API (например, для [плагина recorder](https://www.npmjs.com/package/@saltcorn/recorder)).
  - Если вы работаете за Apache >= 2.4.47, вам потребуется всего две строки в разделе виртуального хоста:
    ```
    # Для идентификации арендатора
    ProxyPreserveHost On 

    ProxyPass / http://localhost:3000/ upgrade=websocket 
    ```

## Советы по разработке

### Сервер разработки

Перейдите в вашу копию репозитория Saltcorn, затем запустите это в оболочке:

`npm run tsc; while [ 1 ]; do SALTCORN_NWORKERS=1 saltcorn serve --dev;done`

Это перезапустит сервер и перестроит с помощью tsc каждый раз, когда вы сохраните файл в репозитории Saltcorn или в локальном плагине.

### Работа с локальными плагинами

Локальный плагин означает, что код находится в вашем домашнем каталоге, и когда вы редактируете его, плагин обновляется в экземпляре после перезапуска (что произойдет автоматически при сохранении, когда вы запускаете сервер разработки).

Если у вас есть плагин, выложенный в каталоге, вы можете установить его в запущенном экземпляре через командную строку двумя разными способами:* Если плагин еще не установлен в экземпляре, запустите `saltcorn install-plugin -d путь_к_плагину` (если плагин выложен в путь_к_плагину).

* Если плагин уже установлен в экземпляре, вы можете преобразовать его в локальный плагин с помощью команды CLI `dev:localize-plugin`: `saltcorn dev:localize-plugin имя_плагина {путь_к_плагину}`.

* Вы также можете деактивировать локализацию плагина, увидеть помощь для `dev:localize-plugin`

### Запуск тестов

Запустите все тесты Jest с `saltcorn run-tests`

Запустите тесты Jest для конкретного пакета: `saltcorn run-tests saltcorn-data` для запуска тестов для пакета данных - третий аргумент должен соответствовать имени директории внутри `packages/`. Отчет о покрытии тестами: `saltcorn run-tests saltcorn-data -c`

Запуск конкретного теста по имени: `saltcorn run-tests saltcorn-data -t 'File class'`


Для запуска Python-базированных тестов безопасности увидьте файл github/pytest.yml.

### Prettier

Мы используем prettier:

`npm install -g prettier`

для форматирования кода:

`git ls-files | grep -v builder_bundle | xargs prettier --write`

Запустите это перед каждым запросом на слияние.


### React сборщик

### Пересборка React при сохранении

в `saltcorn/packages/saltcorn-builder/` выполните:

`git ls-files | entr npm run builddev`

но это не является производственной сборкой, поэтому выполните

`npm run build`

по завершении.

Если вы получаете эту ошибку: `Error: error:0308010C:digital envelope routines::unsupported`,
выполните это и попробуйте снова: `export NODE_OPTIONS=--openssl-legacy-provider`.### Сборка TSDocs

затем

`npm run docs`

TSDocs будут доступны в `docs/`.

Для развертывания этих файлов на https://saltcorn.github.io/tsdocs/: