bot-web-handler/config.php at main · ismailian/bot-web-handler · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<?php
/*
 * This file is part of the Bot Web Handler project.
 * Copyright 2024-2024 Ismail Aatif
 * https://github.com/ismailian/bot-web-handler
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace TeleBot\Config;

/**
 * @var array $config configuration properties
 */
return [

    /**
     * @var string $domain application domain name
     */
    'domain' => getenv('APP_DOMAIN', true),

    /**
     * @param string $token property holding bot token
     */
    'token' => getenv('TG_BOT_TOKEN', true),

    /**
     * @var string $ip property holding source IP
     */
    'ip' => getenv('TG_WEBHOOK_SOURCE_IP', true),

    /**
     * @var array $authorization property holding request signature
     */
    'signature' => getenv('TG_WEBHOOK_SIGNATURE', true),

    /**
     * @var array $admins list of bot admins
     * beneficial for allowing some users elevated access
     */
    'admins' => [],

    /**
     * @var array $users allowed users
     */
    'users' => [

        /**
         * whitelisted users. Leave empty to accept all
         */
        'whitelist' => [],

        /**
         * blacklisted users. Leave empty to accept all
         * this will be overlooked if *whitelist* is not empty
         */
        'blacklist' => [],
    ],

    /**
     * @var string $fallback fallback property for unhandled telegram events
     */
    'fallback' => null,

    /**
     * @var string|callable $maintenance handler to trigger when maintenance mode is enabled
     */
    'maintenance' => null,

    /**
     * @var array $routes allowed routes
     */
    'routes' => [],

    /**
     * @var array $cors CORS configurations
     */
    'cors' => [],
];