Skip to content

Latest commit

 

History

History
222 lines (170 loc) · 7 KB

settings.md

File metadata and controls

222 lines (170 loc) · 7 KB
Raw

Settings

This page describes in detail all the available settings in the settings.json files.

Client

The client-side settings.json only has a single property that specifies the websocket apps connect to.

Example:

{
    "socket": "ws://localhost:2536/"
}

Server

Server-side configuration is more involved, everything will be described in the appropriate section.

Property Type Default Description
database object Database settings
log object {} Logging configuration
websocket object Websocket settings
apps object Available apps and their settings
reload boolean false If true, src/server.py will reload when the sources change

Example:

{
    "database": {
        "class": "peewee.SqliteDatabase",
        "database": "db/db.sqlite"
    },
    "log": {
        "level": "INFO"
    },
    "websocket": {
        "hostname": "localhost",
        "port": 2536
    },
    "apps": {
        "mini_event": {
            "class": "mini_apps.apps.mini_event.MiniEventApp",
            "bot-token": "(your bot token)",
            "url": "https://miniapps.example.com/mini_event/",
            "media-url": "https://miniapps.example.com/media/"
        }
    },
    "api-id": "(your api id)",
    "api-hash": "(your api hash)"
}

database

Database settings, class is one of the Peewee database classes. The rest of the properties here are passed as class constructor arguments.

For peewee.SqliteDatabase, database can be a path (if relative, it will be considered relative from the root of the project) or the string :memory:.

Example:

{
    "class": "peewee.SqliteDatabase",
    "database": "db/db.sqlite"
}

log

Logging configuration. Most entries here correspond to Python's logging.basicConfig.

  • level: Log level for mini-app-specific loggers.
  • global-level: Logging level for all other loggers registered in Python's logging.

Example:

{
    "level": "DEBUG",
    "global-level": "WARN",
    "format": "%(asctime)s %(name)-10s %(message)s",
    "datefmt": "%Y-%m-%d %H:%M:%S"
}

websocket

Web socket server settings.

  • hostname: Socket bind host name or address, to accept remote connections use 0.0.0.0, otherwise localhost should work in most cases.
  • port: Socket TCP port.

Example:

{
    "hostname": "localhost",
    "port": 2536
}

apps

An object where the keys serve as App identifiers, and the values are app-specific settings.

This section will describe all the common app settings. Some apps might require additional settings, refer to each app documentation for details.

All the available settings are listed below, anything without a Default is required.

Property Type Default Description
enabled boolean true If false, the app will not be loaded
class string Python class that runs the bot / app
api-id integer MTProto API ID, you can get its value from https://my.telegram.org/apps
api-hash string MTProto API hash, you can get its value from https://my.telegram.org/apps
telegram-server object null MTProto server settings, described in detail later
session string null session name for Telethon
url string "" Public URL for the app, used to generate webview buttons
fake-user object null For debugging purposes, allows login from a browser without Telegram webview
admins array [] List of telegram ids for users that should always be treated as admins
banned array [] List of telegram ids for users that should be ignored in any request

Example:

{
    "class": "mini_apps.apps.mini_event.MiniEventApp",
    "bot-token": "(your bot token)",
    "url": "https://miniapps.example.com/mini_event/",
    "media-url": "https://miniapps.example.com/media/"
}

Note that each app should have unique values bot-token. If you repeat the bot token, it will still work as long as the selected apps respond to different commands on telegram. The built-in apps all answer to the /start command so that will not work properly if you use the same token for multiple apps.

If you really want to use a single bot with features from multiple apps, you'll need to create your own app and have the Python class inherit from the apps you want to use, and manually override the /start command (or any other conflicting functionality).

telegram-server

Mostly needed if you want to run on the Telegram test server, with the values from https://my.telegram.org/apps.

Example:

{
    "dc": 2,
    "address": "127.0.0.1",
    "port": 443
}

fake-user

Debug user for accessing the app without telegram, it should only be used for local development!

Property Type Default Description
id number Telegram ID
first_name string First name
last_name string "" Last name

Example:

{
    "id": 12345,
    "first_name": "Test"
}

Default App Settings

Note that some settings like api-id, api-hash, telegram-server might be fixed for multiple apps.

So instead of repeating them for each app, you can specify them at the top level of the JSON, and they will be available for all apps. Each app can then override them by having specific values in their own settings.

Example:

{
    "apps": {
        "mini_event": {
            "class": "mini_apps.apps.mini_event.MiniEventApp",
            "session": "minievent",
            "media-url": "http://localhost:2537/media/",
            "url": "http://localhost:2537/mini_event/"
        },
        "glaximini": {
            "class": "mini_apps.apps.glaximini.app.Glaximini",
            "url": "http://localhost:2537/glaximini/"
        }
    },
    "api-id": "(your api id)",
    "api-hash": "(your api hash)",
    "telegram-server": {
        "dc": 2,
        "address": "127.0.0.1",
        "port": 443
    }
}