لوکالت

localet

لوکالت localet
docs · start here

مستندات

از صفر تا اولین لینک عمومی — لوکالت چیست، چطور نصب می‌کنید، چطور وارد می‌شوید، و چطور برنامهٔ روی کامپیوترتان را به اینترنت وصل می‌کنید.

01

لوکالت چیست؟

لوکالت (localet) سرویس ایرانی تانل است: برنامه‌ای که روی کامپیوتر یا لپ‌تاپ خودتان اجرا می‌کنید (مثلاً یک سایت در حال توسعه) را با یک لینک امن در اینترنت در دسترس دیگران قرار می‌دهد — بدون اینکه سرور عمومی جداگانه راه بیندازید.

فکر کنید برنامهٔ شما فقط روی «localhost» دیده می‌شود. لوکالت یک پل امن می‌سازد تا همان برنامه روی آدرسی مثل https://….lclt.ir هم باز شود.
02

نصب کلاینت

کلاینت همان برنامه‌ای است که روی دستگاه شما اجرا می‌شود و اتصال را برقرار می‌کند.

  1. به صفحهٔ دانلود بروید.

  2. سیستم‌عامل خود را انتخاب کنید (لینوکس، مک یا ویندوز).

  3. با یک دستور از صفحهٔ دانلود نصب کنید — دستور آماده است؛ کپی و اجرا کافی است.

اگر ترجیح می‌دهید فایل را دستی بگیرید، همان صفحه بخش «فایل‌های آماده» را با زبانه‌های CLI / GUI / مدیا و «نصب دستی CLI» دارد. بعد از نصب می‌توانید با localet version نسخه را ببینید.

03

ورود و گرفتن توکن

توکن مثل کلید ورود کلاینت به حساب شماست. بدون آن اتصال برقرار نمی‌شود.

  1. از ورود / ثبت‌نام با شماره موبایل وارد شوید (کد یک‌بارمصرف پیامک می‌شود).

  2. وارد پنل کاربر شوید.

  3. یک API Token بسازید و آن را کپی کنید. معمولاً با lt_ شروع می‌شود. مثل رمز عبور نگهش دارید و جایی عمومی نگذارید.

راه‌های دادن توکن به کلاینت

  • --token

    مستقیم در دستور؛ مناسب تست کوتاه

  • LOCALET_TOKEN

    متغیر محیطی — معمولاً راحت‌ترین راه در شل یا اسکریپت

  • LOCALET_TOKEN_FILE

    مسیر فایلی که محتویاتش همان توکن است — مناسب‌تر برای نگه‌داشتن امن روی دیسک

04

وصل شدن

اول برنامه‌ای که می‌خواهید به اینترنت بدهید را روی کامپیوترتان اجرا کنید (مثلاً روی پورت ۳۰۰۰). بعد کلاینت لوکالت را با دستور زیر راه بیندازید.

مثال · لینوکس و مک
export LOCALET_TOKEN='lt_...'
localet client --server tunnel.lclt.ir --token "$LOCALET_TOKEN" --port 3000
مثال · ویندوز (PowerShell)
$env:LOCALET_TOKEN = 'lt_...'
localet client --server tunnel.lclt.ir --token $env:LOCALET_TOKEN --port 3000

پرچم‌های کلاینت

  • --server

    آدرس سرور کنترل تانل (الزامی) — معمولاً tunnel.lclt.ir. چند میزبان را با کاما جدا کنید تا اگر یکی در دسترس نبود بعدی امتحان شود (مثلاً tunnel.lclt.ir,tunnel.example.ir). فهرست فعال‌ها: /api/client/servers

  • --token

    توکن API (lt_…)؛ اگر خالی باشد از LOCALET_TOKEN یا LOCALET_TOKEN_FILE خوانده می‌شود

  • --port

    پورتی که برنامهٔ لوکال شما روی آن گوش می‌دهد (پیش‌فرض ۸۰۸۰)

  • --host

    آدرس سرویس لوکال (پیش‌فرض 127.0.0.1)

  • --subdomain

    ساب‌دامین دلخواه برای همین اتصال (نیاز به پلن با اجازهٔ دلخواه). اگر خالی بگذارید: ساب‌دامین دائمی همان توکن (اگر در پنل → توکن‌ها رزرو شده) وگرنه تصادفی

  • --transport

    auto | ws | quic | tcp — پیش‌فرض auto

  • --insecure

    رد شدن از بررسی گواهی TLS — فقط برای تست؛ در استفادهٔ عادی روشن نکنید

پرچم پیشرفته --ca معمولاً لازم نیست؛ برای ترنسپورت‌های عادی فقط توکن کافی است. در اپ دسکتاپ (localet-gui) فیلد سرور پیش‌فرض «خودکار» است و همان فهرست را از /api/client/servers می‌گیرد.

05

دیدن لینک عمومی

اگر همه چیز درست باشد، کلاینت یک آدرس عمومی به شما نشان می‌دهد.

  1. بعد از اتصال موفق، لینک عمومی داخل یک جعبهٔ مشخص با حاشیهٔ @ در خروجی ترمینال چاپ می‌شود.

  2. همان لینک را در مرورگر باز کنید؛ باید همان صفحه یا API لوکال‌تان را ببینید.

  3. وضعیت تانل‌های فعال را هم می‌توانید در پنل کاربر ببینید.

تا وقتی کلاینت روشن است و برنامهٔ لوکال‌تان کار می‌کند، لینک عمومی در دسترس است. اگر کلاینت را ببندید، لینک قطع می‌شود.
اگر تانل وصل باشد ولی سرویس لوکال‌تان خاموش یا غیرقابل‌دسترس باشد، بازدیدکننده به‌جای خطای خام یک صفحهٔ فارسی برنددار لوکالت می‌بیند («سرویس محلی در دسترس نیست»). برنامهٔ لوکال را روشن کنید تا دوباره محتوا بیاید.
توقف و اتصال مجدد: با Ctrl+C کلاینت را ببندید (نه Ctrl+Z). بعد از توقف، حدود ۵ ثانیه صبر کنید و دوباره وصل شوید — مخصوصاً در پلن رایگان (حداکثر ۱ تانل). اگر اشتباهی Ctrl+Z زدید، در شل jobs و بعد kill %N را بزنید تا فرایند متوقف‌شده از بین برود.
06

نکته‌های بیشتر

برای شروع لازم نیست؛ وقتی راحت شدید این بخش‌ها را مرور کنید.

نحوهٔ اتصال (--transport)

اگر چیزی مشخص نکنید، لوکالت خودش مسیرها را امتحان می‌کند. وقتی شبکه محدود است یا یکی از مسیرها گیر می‌کند، می‌توانید صریح انتخاب کنید:

auto

پیش‌فرض — به‌ترتیب ws، بعد quic، بعد tcp را امتحان می‌کند تا یکی وصل شود

ws

WebSocket — معمولاً بهترین گزینه پشت فایروال، پروکسی و شبکه‌های محدود

quic

QUIC روی UDP — تأخیر کمتر وقتی مسیر شبکه اجازه می‌دهد

tcp

TCP+TLS — همان احراز هویت با توکن مثل ws/quic؛ گواهی کلاینت لازم نیست

مثال · اجبار به WebSocket
localet client --server tunnel.lclt.ir --token "$LOCALET_TOKEN" --port 3000 --transport ws

ساب‌دامین دلخواه و دائمی

دو مفهوم جداست: دلخواه برای یک اتصال با --subdomain، و دائمی برای رزرو نام به‌ازای هر توکن در پنل تا بدون پرچم هم همان آدرس بیاید. رزرو سراسری سطح حساب وجود ندارد.

روی پلنی که ساب‌دامین دلخواه را اجازه می‌دهد می‌توانید با --subdomain myapp آدرس دلخواه بگیرید: https://myapp.lclt.ir (پلن رایگان seed معمولاً فقط تصادفی است — مقدار واقعی را در پنل ببینید).
ساب‌دامین دائمی: اگر پلنتان اجازه دهد، در پنل → توکن‌ها از ستون «ساب‌دامین دائمی» برای هر توکن نام جداگانه رزرو کنید (مودال ثبت / مدیریت). بدون --subdomain همان نام همان توکن اعمال می‌شود؛ حتی وقتی تانل آفلاین است برای دیگران رزرو می‌ماند. حذف رزرو، تانل زنده‌ای که روی آن نام است را قطع می‌کند و ثبت بعدی از دیتابیس دوباره خوانده می‌شود. اگر دائمی نداشته باشید و پرچم هم ندهید، آدرس تصادفی می‌گیرید.

اگر هم دائمی دارید و هم --subdomain بدهید، مقدار پرچم برای آن اتصال اولویت دارد.

پلن، تمدید و پرداخت

در پنل → پلن وضعیت فعلی و کارت‌های ارتقا را می‌بینید. در هر کارت فقط قابلیت‌های فعال همان پلن فهرست می‌شود (مثلاً ساب‌دامین دلخواه یا دائمی فقط اگر روشن باشد). زیر کارت‌ها تاریخچهٔ پلن (فعال / رزرو / منقضی، تاریخ شمسی، صفحه‌بندی ?plh= با ۵ ردیف در صفحه) دیده می‌شود. در نمای کلی باقی‌ماندهٔ پلن و نوار مصرف ترافیک (مصرف‌شده) هم نمایش داده می‌شود.

  • تمدید

    اگر همان پلن پولی را دوباره بخرید، مدت پلن فعلی تمدید می‌شود (راهنمای «?» روی کارت)

  • رزرو

    می‌توانید پلن دیگری را برای بعد از پایان دورهٔ فعلی رزرو کنید؛ پلن فعلی تا آن موقع فعال می‌ماند

  • فعال‌سازی فوری

    در ارتقا، گزینهٔ فوری پلن فعلی را کنسل می‌کند و دورهٔ باقی‌مانده از بین می‌رود

  • پایان پلن

    ابتدا رزرو سررسیدشده اعمال می‌شود؛ وگرنه به رایگان برمی‌گردید، توکن‌ها لغو می‌شوند و تانل‌های زنده قطع می‌شوند

در پرداخت‌ها وضعیت هر تراکنش را می‌بینید. اگر پرداخت را در درگاه لغو کنید یا ناموفق شود، وضعیت ناموفق ثبت می‌شود (نه «در انتظار»).

پشتیبانی (تیکت)

از پنل → پشتیبانی تیکت‌هایتان را می‌بینید. ساخت و گفتگو صفحهٔ چت جداست — نه فرم توکار و نه مودال. ادمین هم گفتگو را در /admin/tickets/… می‌بیند (بدون مودال).

  • تیکت تازه

    /app/tickets/new — موضوع + اولین پیام

  • ادامهٔ گفتگو

    از فهرست «مشاهده» یا مستقیم /app/tickets/{id}

  • پیوست و فایل‌ها

    حداکثر ۵ مگابایت؛ نوار فایل‌ها حدود یک‌چهارم سمت چپ؛ جداکنندهٔ روز شمسی در گفتگو

  • تیکت بسته‌شده

    کاربر نمی‌تواند بازگشایی کند؛ فقط پشتیبانی (ادمین) می‌تواند دوباره باز کند

نکته‌های عملی

  • یک تانل به‌ازای هر توکن

    هر API Token فقط یک تانل زنده دارد؛ کلاینت دوم با همان توکن با پیام token already in use رد می‌شود. بعد از قطع اتصال، همان توکن دوباره قابل استفاده است. برای چند تانل هم‌زمان چند توکن بسازید (تا سقف پلن)

  • توقف درست

    Ctrl+C — نه Ctrl+Z؛ بعد از توقف حدود ۵ ثانیه صبر کنید

  • سقف هم‌زمانی پلن

    جدا از قانون «یک تانل per توکن»، تعداد تانل‌های هم‌زمان حساب هم با MaxTunnels پلن محدود می‌شود (رایگان seed معمولاً ۱)

  • لینک در ترمینال

    بعد از آماده شدن، URL داخل جعبهٔ @ چاپ می‌شود

  • راهنمای ترمینال

    همیشه می‌توانید localet help را بزنید تا همان خلاصهٔ پرچم‌ها و ترنسپورت‌ها را در ترمینال ببینید

باینری را از صفحهٔ دانلود بگیرید و این راهنما را کنار localet help نگه دارید.