serverk.yml

# yaml-language-server: $schema=./serverk.schema.json
schemaVersion: serverk.gg/v1
kind: BotPackage

metadata:
  id: bot-python
  name:
    ar: بوت بايثون
    en: Python bot
  description:
    ar: اربط ريبو GitHub أو ارفع كود بوتك، ونتعرف على طريقة تشغيله تلقائيًا. أضف متغيراتك، وانشر بضغطة واحدة، ونثبّت المكتبات من requirements.txt في بيئة خاصة ببوتك، وتابع كل ما يطبعه لحظة بلحظة.
    en: Link a GitHub repository or upload your bot's code, and we work out how to run it. Add your variables, deploy in one click, and we install the dependencies from requirements.txt into an environment of its own while you follow everything it prints, live.
  tagline:
    ar: أي بوت بـ Python، مع requirements.txt أو uv أو Poetry أو Pipfile، يُنشر من GitHub أو ملف zip
    en: Any Python bot, with requirements.txt, uv, Poetry or Pipfile, deployed from GitHub or a zip
  logo: assets/logo.webp
  banner: assets/banner.webp

resources:
  minMemoryMb: 512
  recommendedMemoryMb: 1024
  minDiskMb: 2048

container:
  image: serverkgg/bot-python
  runtime:
    platform: linux
    installBudgetMinutes: 15
    bootBudgetMinutes: 15
    shmMb: 64
    pidsLimit: 256
  ports:
    - key: web
      containerPort: 8080
      protocol: tcp
      web: true
      hostRange:
        default: 31000
        min: 31000
        max: 31999
      activeWhen:
        - variable: BOT_WEB
          values:
            - "on"
    - key: port1
      containerPort: 29000
      protocol: tcp+udp
      mirror: true
      name:
        ar: المنفذ 1
        en: Port 1
      hint:
        ar: يستقبل TCP و UDP على الرقم نفسه، دون شهادة. ويقرأ بوتك رقمه من SERVERK_PORT_1.
        en: Takes TCP and UDP on the same number, with no certificate. Your bot reads the number from SERVERK_PORT_1.
      hostRange:
        default: 29000
        min: 29000
        max: 29999
      activeWhen:
        - variable: BOT_PORT_1
          values:
            - "on"
    - key: port2
      containerPort: 30000
      protocol: tcp+udp
      mirror: true
      name:
        ar: المنفذ 2
        en: Port 2
      hint:
        ar: يستقبل TCP و UDP على الرقم نفسه، دون شهادة. ويقرأ بوتك رقمه من SERVERK_PORT_2.
        en: Takes TCP and UDP on the same number, with no certificate. Your bot reads the number from SERVERK_PORT_2.
      hostRange:
        default: 30000
        min: 30000
        max: 30999
      activeWhen:
        - variable: BOT_PORT_2
          values:
            - "on"

environment:
  vault: true

backup:
  except:
    - "**/.venv/**"
    - "**/__pycache__/**"
    - .serverk/cache/**
    - .serverk/history/**
    - .serverk/snapshots/**
    - .cache/**
    - logs/**
    - "**/*.log"

reset:
  keep: []

files:
  protected:
    - .serverk/**
  notable:
    - match: requirements.txt
      label:
        ar: المكتبات
        en: Requirements
      icon: box
      color: "#3776ab"
      restart: true
      note:
        ar: المكتبات التي يحتاجها بوتك. نثبّت ما تغيّر منها تلقائيًا في كل نشر. حدّد الإصدارات بـ == حتى لا يتغيّر شيء فجأة.
        en: The libraries your bot needs. We install whatever changed on every deploy. Pin versions with == so nothing changes unexpectedly.
    - match: pyproject.toml
      label:
        ar: ملف المشروع
        en: Project file
      icon: box
      color: "#3776ab"
      restart: true
      note:
        ar: إذا لم يوجد requirements.txt ولا ملف قفل ولا Pipfile، نثبّت مشروعك من هنا بـ uv في كل نشر.
        en: Without a requirements.txt, a lockfile or a Pipfile, we install your project from here with uv on every deploy.
    - match: .env
      label:
        ar: المتغيرات
        en: Environment
      icon: settings
      color: "#e0a458"
      note:
        ar: مكان المتغيرات صفحة المتغيرات في إعدادات بوتك، وليس هذا الملف. ما تضيفه هناك يصل إلى بوتك بالاسم نفسه، وتُحفظ القيم الحساسة مشفّرة.
        en: Variables belong in your bot's settings, not here. Whatever you add there reaches your bot under the same name, and sensitive values are stored encrypted.
    - match: serverk.json
      label:
        ar: إعدادات Serverk
        en: Serverk settings
      icon: settings
      color: "#4cc9f0"
      restart: true
      note:
        ar: وقت التشغيل والمنصة وأمر التثبيت وأمر التشغيل لبوتك. إذا وُجد الملف، نعتمد عليه بدلًا مما نكتشفه من الكود.
        en: Your bot's runtime, platform, and install and start commands. When the file is there, it wins over what we detect from the code.
    - match: .venv
      label:
        ar: بيئة بايثون
        en: Python environment
      icon: puzzle
      color: "#ffd43b"
      note:
        ar: المكتبات المثبّتة لبوتك. لا تحتاج إلى تعديلها، وإذا تلفت فأعد تثبيتها من صفحة بوتك.
        en: The libraries installed for your bot. You never need to touch them, and if they break, reinstall them from your bot's page.

guideTags:
  - id: start
    name:
      ar: ابدأ من هنا
      en: Start here
  - id: deploy
    name:
      ar: النشر
      en: Deploy
  - id: tokens
    name:
      ar: التوكن والمتغيرات
      en: Tokens and variables
  - id: troubleshoot
    name:
      ar: حل المشاكل
      en: Troubleshooting

guides:
  - id: getting-started
    title:
      ar: شغّل بوتك أول مرة
      en: Run your bot for the first time
    summary:
      ar: من صفحة واحدة إلى أول سطر يطبعه بوتك، خطوة بخطوة.
      en: From one page to the first line your bot prints, step by step.
    tags:
      - start
    surfaces:
      - overview
    bodyPath:
      ar: guides/getting-started/ar.md
      en: guides/getting-started/en.md
  - id: environment-variables
    title:
      ar: أضف التوكن والمتغيرات
      en: Add the token and your variables
    summary:
      ar: أين يوضع التوكن، وكيف يصل كل متغير إلى بوتك بالاسم نفسه.
      en: Where the token goes, and how every variable reaches your bot under its own name.
    tags:
      - tokens
      - start
    surfaces:
      - overview
      - console
    bodyPath:
      ar: guides/environment-variables/ar.md
      en: guides/environment-variables/en.md
  - id: moving-in
    title:
      ar: انقل بوتك من استضافة أخرى
      en: Move your bot in from another host
    summary:
      ar: من Replit و Discloud و Railway و Heroku واستضافات Pterodactyl و VPS، ما تحضره معك وما يتغيّر هنا.
      en: From Replit, Discloud, Railway, Heroku, a Pterodactyl host or a VPS, what to bring and what changes here.
    tags:
      - start
      - deploy
    surfaces:
      - overview
      - files
    bodyPath:
      ar: guides/moving-in/ar.md
      en: guides/moving-in/en.md
  - id: connect-github
    title:
      ar: اربط بوتك بريبو GitHub
      en: Link your bot to a GitHub repository
    summary:
      ar: كل push على الفرع ينشر بوتك تلقائيًا، والريبو الخاص مدعوم دون توكن.
      en: Every push to the branch deploys your bot, and private repositories work without a token.
    tags:
      - deploy
    surfaces:
      - overview
      - panel
    bodyPath:
      ar: guides/connect-github/ar.md
      en: guides/connect-github/en.md
  - id: deploy-button
    title:
      ar: أضف زر النشر إلى ريبو بوتك
      en: Add a deploy button to your repository
    summary:
      ar: زر في README يفتح صفحة النشر على ريبو بوتك، لأي ريبو عام على GitHub.
      en: A README button that opens the deploy page on your bot's repository, for any public GitHub repository.
    tags:
      - deploy
    surfaces:
      - overview
    bodyPath:
      ar: guides/deploy-button/ar.md
      en: guides/deploy-button/en.md
  - id: deployments
    title:
      ar: النشرات واسترجاع نشر سابق
      en: Deployments and rolling back
    summary:
      ar: ما يحدث في كل نشر، وكيف ترجّع بوتك إلى آخر نشر كان شغّالًا.
      en: What happens in each deployment, and how to roll your bot back to the last deployment that worked.
    tags:
      - deploy
    surfaces:
      - overview
      - console
    bodyPath:
      ar: guides/deployments/ar.md
      en: guides/deployments/en.md
  - id: upload-zip
    title:
      ar: ارفع كود بوتك دون ريبو
      en: Upload your bot's code without a repository
    summary:
      ar: ارفع مجلد بوتك أو ملف zip، وانشر إصدارًا جديدًا كلما عدّلت.
      en: Upload your bot folder or a zip, and ship a new version whenever you change it.
    tags:
      - deploy
    surfaces:
      - files
      - overview
    bodyPath:
      ar: guides/upload-zip/ar.md
      en: guides/upload-zip/en.md
  - id: upload-rules
    title:
      ar: قواعد رفع الكود
      en: Upload rules
    summary:
      ar: المجلد أو ملف zip، والحدود، والمجلد الذي يغلّف الملفات، والملفات المخفية، وماذا يحدث لملف .env.
      en: A folder or a zip, the limits, the folder around your files, hidden files, and what happens to .env.
    tags:
      - deploy
    surfaces:
      - files
      - overview
    bodyPath:
      ar: guides/upload-rules/ar.md
      en: guides/upload-rules/en.md
  - id: project-shapes
    title:
      ar: كيف نثبّت مشروع بايثون ونشغّله
      en: How we install and start a Python project
    summary:
      ar: requirements.txt و uv و Poetry و PDM و Pipfile، وإصدار بايثون، وترتيب أمر التشغيل حتى python -m، وأمر ما قبل النشر.
      en: requirements.txt, uv, Poetry, PDM and Pipfile, the Python version, the start order down to python -m, and the pre-deploy command.
    tags:
      - deploy
    surfaces:
      - overview
      - console
    bodyPath:
      ar: guides/project-shapes/ar.md
      en: guides/project-shapes/en.md
  - id: data-and-backups
    title:
      ar: بيانات بوتك والنسخ الاحتياطية
      en: Your bot's data and backups
    summary:
      ar: ما يستبدله النشر والرفع واسترجاع نشر سابق أو نسخة احتياطية والريسيت من ملفات بوتك، وأين تحفظ بياناته لتبقى.
      en: What a deployment, an upload, a rollback, a restore and a reset each replace in your bot folder, and where to keep your data so it stays.
    tags:
      - deploy
    surfaces:
      - backups
      - files
      - overview
    bodyPath:
      ar: guides/data-and-backups/ar.md
      en: guides/data-and-backups/en.md
  - id: web-address
    title:
      ar: عنوان الويب والمنافذ لبوتك
      en: Your bot's web address and ports
    summary:
      ar: فعّل لبوتك عنوان HTTPS ومنفذين لـ TCP و UDP، لاستقبال الـ webhook من تيليقرام وتفاعلات ديسكورد وتقديم صفحاتك.
      en: Turn on an HTTPS address and two TCP and UDP ports for your bot, for Telegram webhooks, Discord interactions and your own pages.
    tags:
      - deploy
    surfaces:
      - overview
      - console
    bodyPath:
      ar: guides/web-address/ar.md
      en: guides/web-address/en.md
  - id: discord-token
    title:
      ar: توكن بوت ديسكورد والـ Intents والصلاحيات
      en: Your Discord bot's token, intents and permissions
    summary:
      ar: من Developer Portal إلى التوكن في متغيرات بوتك، ثم الـ Intents التي يطلبها كودك، ورابط الإضافة والصلاحيات.
      en: From the Developer Portal to the token in your variables, then the intents your code asks for, the invite link and the permissions.
    tags:
      - tokens
    surfaces:
      - overview
      - panel
    bodyPath:
      ar: guides/discord-token/ar.md
      en: guides/discord-token/en.md
  - id: telegram-token
    title:
      ar: أين تجد توكن بوت تيليقرام
      en: Where to find your Telegram bot token
    summary:
      ar: أنشئ بوتك من BotFather وأضف التوكن إلى متغيراته خلال دقيقة.
      en: Create your bot with BotFather and put its token in your variables in a minute.
    tags:
      - tokens
    surfaces:
      - overview
      - panel
    bodyPath:
      ar: guides/telegram-token/ar.md
      en: guides/telegram-token/en.md
  - id: read-the-logs
    title:
      ar: اقرأ الكونسول وافهم ما حدث
      en: Read the console and work out what happened
    summary:
      ar: معنى سطور serverk، وكيف تجد سبب الخطأ عندما يفشل النشر أو يتعطّل بوتك.
      en: What the serverk lines mean, and how to find the cause when a deployment fails or your bot crashes.
    tags:
      - troubleshoot
    surfaces:
      - console
      - overview
    bodyPath:
      ar: guides/read-the-logs/ar.md
      en: guides/read-the-logs/en.md
  - id: errors
    title:
      ar: أخطاء بوتك وحلولها
      en: Your bot's errors and how to fix them
    summary:
      ar: السطر الذي تطبعه المكتبة لكل سبب نعرفه، وما تفعله لتصلحه.
      en: The line the library prints for every cause we name, and what to do to fix it.
    tags:
      - troubleshoot
    surfaces:
      - console
      - overview
    bodyPath:
      ar: guides/errors/ar.md
      en: guides/errors/en.md