مرجع نصب‌کننده
همه چیزهایی که نصب‌کنندهٔ veilway.sh می‌تواند. برای نصب اول، به‌جای این صفحه شروع به کار یا شروع سریع را بخوانید.
اسکریپت را بدون آرگومان اجرا کنید:
| کلید | کار | دستور |
|---|---|---|
| 1 | نصب | install node|panel|both |
| 2 | به‌روزرسانی | update (هر دو) |
| 3 | وضعیت | status |
| 4 | گزارش‌ها | logs node یا logs panel |
| 5 | راه‌اندازی مجدد | restart (هر دو) |
| 6 | بررسی | check |
| 7 | تشخیص | doctor |
| 8 | پشتیبان‌گیری | backup |
| 9 | بازگردانی | restore <file> |
| 10 | حذف | uninstall |
| 11 | افزونه‌ها | addon xray status، و بعد می‌پرسد که نصب یا حذف شود |
| 12 | مدیران | admin list، و بعد نام کاربری‌ای را می‌پرسد که گذرواژهٔ تازه بگیرد |
| 0 | خروج |
دستورها
Section titled “دستورها”| دستور | کاری که انجام می‌دهد |
|---|---|
install node|panel|both|mirror [--version vX.Y.Z] |
بخش‌های انتخاب‌شده را از آخرین نسخه، یا از برچسبی که می‌دهید، نصب می‌کند. mirror یک آینهٔ رله از نقطهٔ پایانی اشتراک نصب می‌کند. آینه‌های رله را ببینید. |
install panel|both --domain <name> [--web caddy|nginx] |
علاوه بر آن برای آن دامنه یک وب‌سرور با HTTPS راه می‌اندازد، و برای هر مسیر دیگر یک سایت ساده. یک وب‌سرور جلوی پنل بگذارید را ببینید. |
install panel|both --no-two-step |
نصب تازهٔ پنل می‌پرسد که هنگام ورود کد برنامهٔ احراز هویت خواسته شود یا نه، و جواب بله است مگر نه بگویید. این گزینه بدون پرسیدن نه می‌گوید. پیشنهاد نمی‌شود: با خاموش بودنش، رمز مدیر به‌تنهایی پنل را باز می‌کند. از v0.3.4. |
update [node|panel|mirror|both] |
آخرین نسخه یا برچسبی که می‌دهید را نصب می‌کند و سرویس را دوباره راه می‌اندازد. نصب‌کنندهٔ ذخیره‌شده، /usr/local/sbin/veilway.sh، را هم با نسخهٔ امضاشدهٔ همان انتشار جایگزین می‌کند، هرگز با نسخهٔ قدیمی‌تر. دکمه‌های به‌روزرسانی پنل آن را اجرا می‌کنند. به‌روزرسانی پنل را ببینید. |
status |
وضعیت و نسخهٔ هر سرویس و پوشه‌های پیکربندی و وضعیت را نشان می‌دهد. root لازم ندارد. با root نشانی صفحه‌های مدیریت پنل، مسیر اشتراک و نام کاربری مدیران را هم نشان می‌دهد. |
logs [node|panel|mirror] |
۱۰۰ خط آخر گزارش سرویس را دنبال می‌کند. |
restart [node|panel|mirror|both] |
سرویس را دوباره راه می‌اندازد. راه‌اندازی مجدد نود همهٔ تونل‌های زنده را لحظه‌ای قطع می‌کند. |
check |
دستور veilway check را روی پیکربندی نود اجرا می‌کند. |
doctor |
دستور veilway doctor را با مسیرهای خود سرویس روی نود اجرا می‌کند. فقط می‌خواند. |
backup [file] |
یک tar.gz از پیکربندی، وضعیت مصرف نود، داده‌های پنل و پیکربندی آینه می‌نویسد. کلید دارد، و تا وقتی gateway.next روی سرور است آن را هم، پس خصوصی نگهش دارید. |
restore <file> |
بعد از تأیید شما پشتیبان را بازمی‌گرداند. اول فایل‌های فعلی را ذخیره می‌کند. |
admin [list|reset <username>] |
list نام کاربری مدیران را نشان می‌دهد. reset برای قفل شدن است: دو بار گذرواژهٔ تازه‌ای با ۱۲ نویسه یا بیشتر می‌پرسد، آن را به آن مدیر می‌دهد و او را از همه‌جا بیرون می‌اندازد. کلید احرازگر و توکن‌های API او می‌مانند. پنل v0.2.5 یا تازه‌تر لازم است. |
addon xray [install|remove|status] |
افزونهٔ Xray را نصب، حذف یا وضعیتش را نشان می‌دهد. پیش‌فرض install است. یک انتشار سنجاق‌شده از Xray-core رسمی را دانلود می‌کند و اگر SHA-256 آن با مقدار داخل اسکریپت یکی نباشد رد می‌کند. فایل اجرایی xray در /usr/local/lib/veilway/addons/xray می‌رود، با مالک root. Xray با کاربر جدای veilway-xray اجرا می‌شود و نود وقتی پیکربندی‌اش ورودی Xray دارد آن را راه می‌اندازد. افزونهٔ Xray را ببینید. |
mirror-sync <folder> [--version vX.Y.Z] |
یک انتشار نود و پنل را با امضاها و اشاره‌گرهای امضاشدهٔ latest در پوشه‌ای با چینش GitHub کپی می‌کند و هر فایل را پیش از ذخیره بررسی می‌کند. پوشه را سرو کنید یا روی فلش ببرید. نصب از یک آینه را ببینید. root لازم ندارد. |
uninstall |
فایل‌های اجرایی، یونیت‌ها و خود نصب‌کننده را حذف می‌کند. پیش از حذف پیکربندی و داده‌ها می‌پرسد. پشتیبان‌ها می‌مانند. تنظیمات وب‌سرور تا uninstall web می‌ماند، که نصب‌کننده لازم دارد. |
uninstall web |
آنچه --domain راه انداخته را برمی‌گرداند: فایل سایت، سایت ساده اگر ویرایشش نکرده باشید، not_found پنل، و بسته‌هایی که اسکریپت نصب کرده. |
version |
نسخهٔ اسکریپت، نود و پنل را چاپ می‌کند. |
پرچم‌ها:
--dry-runمی‌گوید دستور چه می‌کرد و چیزی را عوض نمی‌کند.--yes(یا-y) به هر پرسش جواب پیش‌فرضش را می‌دهد.--version <tag>به‌جای آخرین نسخه، یک برچسب انتشار را انتخاب می‌کند.--allow-downgradeاجازه می‌دهد--versionبرچسبی قدیمی‌تر از نسخهٔ نصب‌شده بگیرد. بدون آن اسکریپت رد می‌کند، و با آن هشدار می‌دهد.--mirror <url>از یک آینه نصب می‌کند (برای چند آینه تکرار کنید). نصب از یک آینه را ببینید.--mirror-onlyهرگز به GitHub برنمی‌گردد.--domain <name>و--web caddy|nginxیک وب‌سرور برای پنل راه می‌اندازند. پیش‌فرضcaddyاست.
متغیرهای محیطی:
NO_COLORرنگ‌ها را خاموش می‌کند.VEILWAY_PANEL_PORTدرگاه پنل را تعیین می‌کند. پیش‌فرض8480است.VEILWAY_MIRRORSنشانی آینه‌ها را می‌گیرد، جدا شده با فاصله. بعد از--mirrorها امتحان می‌شوند.
محل فایل‌ها
Section titled “محل فایل‌ها”| مسیر | محتوا |
|---|---|
/usr/local/bin/veilway |
فایل اجرایی نود |
/usr/local/bin/veilway-panel |
فایل اجرایی پنل |
/etc/veilway/node/config.json |
پیکربندی نود. مالک veilway، حالت 0600 |
/etc/veilway/config.example.json |
پیکربندی نمونه از انتشار |
/etc/veilway/panel.json |
پیکربندی پنل |
/var/lib/veilway/veilway-state.json |
وضعیت مصرف نود |
/var/lib/veilway/veilway-replay |
حافظهٔ بازپخش نود |
/var/lib/veilway-panel/panel.db |
پایگاه داده پنل |
/var/lib/veilway-panel/panel.keys |
کلیدهای پنل برای رازهای رمزشده |
/var/lib/veilway-panel/signing.keys |
کلیدهای امضای اشتراک |
/var/lib/veilway-panel/gateway.keys |
کلیدهای دروازه که درخواست‌های اشتراک را باز می‌کنند |
/var/lib/veilway-panel/gateway.next |
نیمهٔ خصوصی کلید دروازهٔ بعدی، تا وقتی آن را از سرور بیرون نبرده‌اید |
/etc/veilway-mirror/mirror.json |
پیکربندی آینهٔ رله، اگر نصب کرده باشید |
/usr/local/lib/veilway/addons/xray |
افزونهٔ Xray، اگر نصب کرده باشید |
/run/veilway/control.sock |
سوکت کنترل نود، با گروه veilway |
/etc/systemd/system/veilway.service |
یونیت نود |
/etc/systemd/system/veilway-panel.service |
یونیت پنل |
/var/backups/veilway |
پشتیبان‌ها، و نسخه‌هایی که اسکریپت پیش از بازنویسی یک فایل می‌گیرد |
نسخه‌های نصب‌شده در /var/lib/veilway/node.version و /var/lib/veilway-panel/panel.version هستند.