FASTPANELWIKI

CLI

Базы данных

На этой странице

Получение списка серверов баз данных

Команда

mogwai databases servers list

Пример вывода

ID      NAME                    TYPE            LOCAL   HOST    USERNAME        AVAIL
1       mysql(localhost)        mysql           true            fastuser        true
2       postgresql(localhost)   postgresql      true            fastuser        true

Сервер IDs используется в других командах.

Получение списка баз данных

Команда

mogwai databases list

Пример вывода

ID      NAME            SERVER_NAME             LOCAL           HOST    CHARSET OWNER   SIZE    CREATE_AT                              
1       db1             mysql(localhost)        localhost       true    utf8mb4 user    0       2024-05-28 10:03:03.227413266 +0000 UTC
2       database43s     mysql(localhost)        localhost       true    utf8mb4 user82  0       2024-05-28 10:07:15.001640584 +0000 UTC

Синхронизация списка баз данных

Если вы недавно добавили или удалили базы данных и они ещё не появились в FASTPANEL, вы можете принудительно синхронизировать списки

Команда

mogwai databases sync

Создание новой базы данных

Команда

mogwai databases create [flags]

Параметры

  • -n, --name=NAME : Имя базы данных.
  • -o, --owner="fastuser" :  пользователь FASTPANEL, которому будет добавлена база данных.
  • -s, --site=SITE : Сайт в FASTPANEL, к которому будет добавлена база данных.
  • -c, --charset="utf8mb4" : Кодировка базы данных.
  • -u, --username=USERNAME : Имя пользователя базы данных.
  • -p, --password=PASSWORD : Пароль пользователя базы данных.

Пример команды

mogwai databases create --server=1 -n db1 -o fastuser -s example.com -u dbuser -p dbpassword1

Эта команда создаст базу данных с именем db1 на сервере баз данных по умолчанию (--server=1) и "привяжет" её к сайту example.com.

Описание

На этой странице

FASTPANEL предоставляет интерфейс командной строки (CLI), реализованный с помощью утилиты mogwai (/usr/local/bin/mogwai). Утилита будет работать только при запуске от имени root.

Справка

Чтобы увидеть список доступных команд, используйте:

mogwai --help

Чтобы узнать больше о конкретной команде, используйте:

mogwai command --help

Чтобы увидеть список команд с описаниями, используйте:

mogwai --help-long

Веб-сайты

На этой странице

Список сайтов на сервере

Команда

mogwai sites list

Пример вывода

ID      SERVER_NAME             ALIASES                         OWNER                   MODE    PHP_VERSION     IPS             DOCUMENT_ROOT
1       example.com             www.example.com                 example_com_usr         mpm_itk 82              127.0.0.1   /var/www/example_com_usr/data/www/example.com

Примечание: Сайт IDs из этого списка используется в других командах.

Создание нового сайта

Команда

mogwai sites create --server-name=SERVER-NAME --owner=OWNER [<flags>]

Опции

  • --owner : Пользователь в системе FASTPANEL, который будет владельцем сайта.
  • --server-name=SERVER-NAME : Доменное имя сайта.
  • -a, --alias=ALIAS : Псевдонимы сайта, например поддомены www. Можно указать несколько псевдонимов.
  • --ip=IP : IP-адрес сервера, на котором будет работать сайт. Можно указать несколько IP-адресов.
  • -h, --handler=HANDLER : Обработчик бэкенда. Может быть:
    • PHP: cgi,mpm_itk,php_fpm,fcgi;
    • Node.js: standalone,pm2;
    • Systemd: systemd.
  • --handler_version=HANDLER_VERSION : Версия PHP или Node.js (например, 8.2, 8.3, 20.15.1).
  • --create-user : Создать пользователя для сайта.

Пример команды

mogwai sites create --server-name=example.com --owner=user --create-user --alias=www.example.com --ip=127.0.0.1 --handler=fcgi --handler_version=7.3

Удаление сайта

Команда

mogwai sites delete --id=ID

Сайт ID можно получить из команды mogwai sites list.

Пример команды

mogwai sites delete --id=987

Эта команда удалит сайт с ID 987

Изменение настроек сайта

Команда

mogwai sites update --id=ID [<flags>]

Сайт ID можно получить из команды mogwai sites list.

Опции

  • -i, --id=ID : ID сайта.
  • -a, --add-alias=ADD-ALIAS : Добавить псевдоним, можно указать несколько псевдонимов.
  • --del-alias=DEL-ALIAS : Удалить псевдоним, можно указать несколько псевдонимов.
  • --add-ip=ADD-IP : Добавить IP-адрес в настройки сайта, можно указать несколько IP-адресов.
  • --del-ip=DEL-IP : Удалить IP-адрес из настроек сайта, можно указать несколько IP-адресов.
  • -h, --handler=HANDLER : Обработчик бэкенда. Может быть:
    • PHP: cgi,mpm_itk,php_fpm,fcgi;
    • Node.js: standalone,pm2;
    • Systemd: systemd.
  • --handler_version=HANDLER_VERSION : Версия PHP или Node.js (например, 8.2, 8.3, 20.15.1).
  • --gzip : Включить сжатие.
  • --no-gzip : Отключить сжатие.
  • --gzip-comp-level=LEVEL : Установить уровень сжатия, 1-9.
  • --expires=EXPIRES : Установить время кэширования для статического контента.
  • --worker-count=WORKER-COUNT : Установить количество workers для PHP-FPM

Вы также можете обновить настройки для нескольких сайтов на сервере с помощью команды

mogwai sites batch-update
  • Чтобы изменить настройки для всех сайтов, используйте флаг -a.
  • Чтобы изменить настройки для выбранных сайтов, укажите несколько флагов --id с их IDs.

Пример команды

mogwai sites update --id=1 -a www1.example.com -h cgi --handler_version=5.6

Эта команда добавит псевдоним www1.example.com, изменит обработчик на cgi и версию PHP на 5.6 для сайта с ID 3

Пример команды

mogwai sites batch-update -h cgi --handler_version=5.6 --id 3 --id 2

Эта команда изменит обработчик PHP для сайтов с ID 2 и 3

Перенос пользователей между FASTPANEL

На этой странице

Введение

В этой статье описан процесс переноса учетных записей пользователей и связанных с ними данных (веб-сайтов, баз данных, электронной почты и т. д.) с одного сервера FASTPANEL на другой с помощью встроенной утилиты миграции.

Ключевые термины

  • Исходный сервер - сервер, с которого переносятся данные.
  • Целевой сервер - сервер, на который переносятся данные.

Важные примечания

  • По умолчанию миграция корректно работает только для сайтов со стандартной конфигурацией FASTPANEL.

  • Сайты с ручными изменениями конфигурации можно перенести только при использовании флага -m для сопоставления IP-адресов.

  • Если зашифрованный пароль владельца базы данных недоступен, база данных не будет перенесена.

  • Если веб-сайт не переносится, связанные с ним базы данных также не будут перенесены.

  • Можно переносить только локальные базы данных.

Процесс миграции

Подключение

Целевой сервер подключается к исходному серверу по SSH. При первом подключении целевой сервер устанавливает SSH-ключ на исходный сервер (либо заранее предоставленный, либо сгенерированный из пароля).

Этапы миграции

  • Установка модуля
  • Сбор информации о переносимых объектах
  • Создание пользователей
  • Перенос SSL-сертификатов
  • Создание веб-сайтов, FTP-аккаунтов, почтовых доменов и почтовых аккаунтов
  • Создание баз данных и пользователей баз данных
  • Перенос файлов веб-сайтов и почтовых ящиков
  • Перенос заданий cron

Передача файлов выполняется с помощью rsync. Базы данных переносятся путем создания дампа через SSH-туннель.

Команда для запуска миграции

Команда выполняется на целевом сервере пользователем с правами root:

/usr/local/fastpanel2/fastpanel transfer run [SSH_PARAMETERS] [IP_PARAMETERS] [ADDITIONAL_OPTIONS]

Флаги командной строки

SSH-подключение

  • --remote_host="SOURCE_IP" - IP-адрес исходного сервера.
  • --remote_port="SSH_PORT" - порт SSH.
  • --remote_username="SSH_USER" - пользователь (должен быть root).
  • --remote_password="USER_PASSWORD" - пароль указанного SSH-пользователя.
  • --ssh_key_path="PATH_TO_KEY" - путь к приватному SSH-ключу на целевом сервере для подключения к исходному серверу. Если используется ключ, пароль (--remote_password) не требуется.

IP-адреса

Для управления IP-адресами сайтов во время переноса необходимо использовать только один из следующих флагов. Флаг -m имеет приоритет.

  • -i "IP_ADDRESS_ON_DESTINATION" - назначает указанный IP-адрес всем перенесенным сайтам на целевом сервере. Чтобы указать несколько IP-адресов (например, если на исходном сервере их было несколько), повторите флаг для каждого исходного IP-адреса, который нужно перенести.

  • -m "SOURCE_IP,DESTINATION_IP" - рекомендуемый способ. Устанавливает прямое сопоставление: все сайты, использующие SOURCE_IP на исходном сервере, будут использовать DESTINATION_IP на целевом сервере. Этот флаг можно указывать несколько раз для разных пар IP. Обязательно для переноса сайтов с ручными изменениями конфигурации, так как позволяет корректно заменить IP-адреса в директивах listen.

Дополнительные настройки

  • --users="USER_LIST" - переносит только указанных пользователей (через запятую). Если не указано, переносятся все пользователи.
  • --disable_disk_quota - отключает перенос дисковых квот пользователей.
  • --with_user_data - включает копирование всего содержимого домашних каталогов пользователей (кроме подкаталога logs/). Используйте с осторожностью, так как это может значительно увеличить время переноса и объем передаваемых данных.
  • --only_data - переносит только данные (файлы веб-сайтов, почтовые файлы, дампы баз данных). Полезно, если начальная миграция структуры (пользователи, сайты, БД и т. д.) прошла успешно, но на этапе копирования файлов или дампов произошли ошибки. Позволяет повторно запустить только часть, связанную с копированием данных.
  • --transfer_timeout - устанавливает тайм-аут операции (по умолчанию 60 минут).

Пример команды

Перенос всех пользователей с сервера 11.22.33.44 на текущий сервер. На старом сервере сайты использовали IP-адреса 11.22.33.44 и 11.22.33.55; на новом сервере они должны использовать 99.88.77.66 и 99.88.77.67 соответственно. Подключение по SSH с использованием пароля.

/usr/local/fastpanel2/fastpanel transfer run \
--remote_host=11.22.33.44 \
--remote_username=root \
--remote_password=YourSourceRootPassword \
-m 11.22.33.44,99.88.77.66 \
-m 11.22.33.55,99.88.77.67

Возможные проблемы и типы ошибок

Ошибка в журнале миграции не всегда указывает на критическую проблему, но может указывать на причину, по которой конкретный объект не был перенесен.

  • Конфликты: возникают, когда перенос объекта невозможен из-за текущей конфигурации целевого сервера (например, пользователь или сайт с таким же именем уже существует) или если конфигурация сайта на исходном сервере неизвестна панели (например, из-за значительных ручных изменений).

  • Отсутствует сохраненный пароль: как упоминалось ранее, пользователи баз данных MySQL без сохраненного пароля в FASTPANEL на исходном сервере не могут быть перенесены.

  • Ручные настройки и IP-адреса: если сайт на исходном сервере имеет ручные изменения конфигурации веб-сервера и во время миграции для сопоставления его IP-адреса не используется флаг -m, такой сайт не будет перенесен, потому что панель не знает, какой IP-адрес указать в конфигурации на целевом сервере.

Пользователи

На этой странице

Создание нового пользователя

Команда

mogwai users create --username=USERNAME --password=PASSWORD [--role="USER"]

Параметры

  • -u, --username=USERNAME : Укажите имя пользователя для нового пользователя.
  • -p, --password=PASSWORD : Укажите пароль для нового пользователя.
  • -r, --role="USER" : Укажите роль для нового пользователя. Поддерживаемые роли: RESELLER и USER. Роль по умолчанию — USER.

Информация об использовании

Чтобы создать нового пользователя с именем testuser, паролем My$ecretPassword123 и ролью RESELLER, используйте следующую команду:

mogwai users create --username=testuser --password=My$ecretPassword123 --role="RESELLER"

Дополнительные примечания

  • Имена пользователей должны быть уникальными и не могут содержать пробелы или точки.
  • Пароли должны содержать не менее 8 символов. Мы рекомендуем использовать как минимум одну заглавную букву, одну строчную букву, одну цифру и один специальный символ.

Электронная почта

На этой странице

Получение списка почтовых доменов

Команда

mogwai emails domains list

Пример вывода

ID      NAME            FALLBACK        DKIM    ENABLED OWNER_ID        OWNER           CREATE_AT
1       example.com                     true    true    1               example_com_usr 2024-01-04 15:46:02+03:00

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

Добавление почтового домена

Команда

mogwai emails domains create

Параметры

  • --domain=DOMAIN : Имя почтового домена.
  • -o, --owner="fastuser" : Пользователь FASTPANEL, которому будет добавлен почтовый домен.

Пример создания почтового домена example1.com для пользователя fastuser

mogwai emails domains create --domain=example1.com -o fastuser

Получение списка почтовых ящиков

Команда

mogwai emails boxes list

Параметры

  • --domain=DOMAIN : Имя почтового домена

Пример команды

mogwai emails boxes list --domain example.com

Пример вывода

ID      ADDRESS                 ALIASES REDIRECTS       SIZE    QUOTA   ENABLED OWNER_ID        OWNER           CREATE_AT
1       user@example.com                                0       0       true    4               example_com_usr 2024-02-08 11:13:01+03:00

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

Создание почтового ящика

Команда

mogwai emails boxes create

Параметры

  • --domain=DOMAIN : Имя почтового домена.
  • -l, --login=LOGIN : Имя почтового ящика без домена.
  • -p, --password=PASSWORD : Пароль для почтового ящика.

Пример команды

mogwai emails boxes create  --domain=example.com --login=user --password=MySecretPassword123

Эта команда создаст почтовый ящик с именем user@example.com и паролем MySecretPassword123.

Удаление почтового ящика

Команда

mogwai emails boxes delete

Параметры

  • -b, --box=BOX : ID почтового ящика..

Пример команды

mogwai emails boxes delete -b 1

Эта команда удалит почтовый ящик с ID 1.

Импорт почтовых ящиков и писем

Команда

mogwai emails boxes import[sync] [<flags>]

Параметры

  • -i, --import_config=IMPORT_CONFIG : Путь к файлу со списком для импорта
  • --force : Только для режима import — очистить существующие почтовые ящики.

Чтобы импортировать почту, необходимо подготовить список почтовых ящиков на сервере в формате:

IMAP_HOST;SOURCE_ADDR;SOURCE_PASSWORD;DEST_ADDR

Параметры

  • IMAP_HOST : Адрес IMAP-сервера почты.
  • SOURCE_ADDR : Почтовый ящик на исходном сервере.
  • SOURCE_PASSWORD : Пароль для IMAP-подключения к почтовому ящику на исходном сервере. Некоторые сервисы, такие как Google, требуют создания пароля приложения для доступа по IMAP https://support.google.com/accounts/answer/185833?hl=en
  • DEST_ADDR : Почтовый ящик на сервере FASTPANEL, в который переносятся сообщения.

Пример содержимого файла

imap.gmail.com;test@gmail.comu;password;test@example.com
imap.gmail.com;test1@gmail.com;password;test1@example.com

Доступны два режима:

Режим импорта

mogwai emails boxes import

В этом режиме все сообщения копируются полностью, почтовые ящики на сервере FASTPANEL не должны быть созданы или должны быть пустыми — при выполнении команды FASTPANEL создаёт необходимые почтовые ящики. Если почтовые ящики с содержимым уже существуют, будет показана ошибка. Вы можете использовать флаг --force — тогда почтовый ящик будет очищен.

Пример запуска команды со списком почтовых ящиков, сохранённым в файле /root/import.txt, и с использованием ключа --force

mogwai emails boxes import --import_config=/root/import.txt --force

Режим синхронизации

mogwai emails boxes sync

В этом режиме Панель управления загружает сообщения с исходного сервера, ничего не удаляя. Его следует использовать, если после первого импорта в исходном почтовом ящике появились новые сообщения, которые также необходимо перенести.

Пример команды

mogwai emails boxes sync --import_config=/root/import.txt