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 : Задаць колькасць worker-працэсаў для 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

Карыстальнікі

На гэтай старонцы

Стварэнне новага карыстальніка

Каманда

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-адрас трэба ўказаць у канфігурацыі на мэтавым серверы.

Апісанне

На гэтай старонцы

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