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.

Вебсайти

На цій сторінці

Перелік сайтів на сервері

Команда

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 : Установити кількість воркерів для 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 надає інтерфейс командного рядка (CLI), реалізований за допомогою утиліти mogwai (/usr/local/bin/mogwai). Утиліта працюватиме, лише якщо її запущено від імені root.

Довідка

Щоб переглянути список доступних команд, використовуйте:

mogwai --help

Щоб дізнатися більше про конкретну команду, використовуйте:

mogwai command --help

Щоб переглянути список команд з описами, використовуйте:

mogwai --help-long

Електронна пошта

На цій сторінці

Отримання списку доменів електронної пошти

Команда

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

Користувачі

На цій сторінці

Створення нового користувача

Команда

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 символів. Ми рекомендуємо використовувати щонайменше одну велику літеру, одну малу літеру, одну цифру та один спеціальний символ.

Перенесення користувачів між 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-адреси: Якщо сайт на вихідному сервері має ручні зміни конфігурації вебсервера і під час міграції не використовується прапорець -m для зіставлення його IP-адреси, такий сайт не буде перенесено, оскільки панель не знає, яку IP-адресу вказати в конфігурації на цільовому сервері.