app.json

{
    "name": "Paperplane userbot project fork",
    "description": "A modular Telegram userbot running on Python3, which can be coupled up with Mongo DB and a Redis backend.",
    "logo": "https://camo.githubusercontent.com/c9497896ad221daba6cb84f897e7ec00ba46f430/68747470733a2f2f74656c656772612e70682f66696c652f3733636634633632623263363466393831393631652e706e67",
    "keywords": [
      "telegram",
      "userbot",
      "plugin",
      "modular",
      "productivity"
    ],
    "repository": "https://github.com/PolisanTheEasyNick/Telegram-UserBot/",
    "website": "https://github.com/PolisanTheEasyNick/Telegram-UserBot/",
    "success_url": "#TODO",
    "stack": "container",
    "env": {
        "API_KEY": {
            "description": "Get from https://my.telegram.org/.",
            "required": true
        },
        "API_HASH": {
            "description": "Get from https://my.telegram.org/.",
            "required": true
        },
        "STRING_SESSION": {
            "description": "Generate using generate_string_session.py.",
            "required": true
        },
        "HEROKU_APIKEY": {
            "description": "Get from 'https://dashboard.heroku.com/account'. It's neede for userbot updates.",
            "required": false
        },
        "HEROKU_APPNAME": {
            "description": "Add the Heroku app name here. It's needed for userbot updates.",
            "required": false
        },
        "MONGO_DB_URI": {
            "description": "Your MongoDB Atlas URL.",
            "required": true 
        },
        "SCREENSHOT_ACCESS_LAYER_KEY": {
            "description": "Screenshot Layer API Key for .screenshot command. Get from https://screenshotlayer.com/. Please refer to README for getting the key.",
            "required": false 
        },
        "OPEN_WEATHER_MAP_APPID": {
            "description": "OpenWeather Map API Key for .weather command. Get from https://openweathermap.org/.",
            "required": false
        },
        "BOTLOG": {
            "description": "In case you want to turn on logging, set this True.",
            "value": "False",
            "required": false 
        },
        "BOTLOG_CHATID": {
            "description": "Chat ID for Botlog. Get it from group management bots such as Marie or her forks.",
            "value": "0",
            "required": false 
        },
        "CONSOLE_LOGGER_VERBOSE": {
            "description": "If you want verbosity on the Logging.",
            "value": "False",
            "required": false 
        },
        "PM_AUTO_BAN": {
            "description": "PM Auto-Ban Feature Switch.",
            "value": "False",
            "required": false  
        },
        "SPOTIFY_KEY": {
            "description": "Spotify cache key. See sample_config.env to know how to get it.",
            "required": false
        },
        "SPOTIFY_DC": {
            "description": "Spotify cache DC. See sample_config.env to know how to get it.",
            "required": false
        },
        "MONGO_DB_URI": {
            "description": "Your MongoDB Atlas URL",
            "required": true
        },
        "DATABASE_URL": {
            "description": "PostgreSQL, recommend for free: elephantsql.com",
            "required": true
        },
        "LASTFM_API": {
            "description": "API Key for Last.FM module. Get from https://www.last.fm/api/account/create.",
            "required": false
        },
          "LASTFM_SECRET": {
            "description": "SECRET Key for Last.FM module. Get from https://www.last.fm/api/account/create.",
            "required": false
        },
          "LASTFM_USERNAME": {
            "description": "Last.FM Username",
            "required": false
        },
          "LASTFM_PASSWORD": {
            "description": "Last.FM Password",
            "required": false
        },
          "OCR_SPACE_API_KEY": {
            "description": "API Key for http://ocr.space/.",
            "required": false
        },
          "REM_BG_API_KEY": {
            "description": "API Key for https://remove.bg.",
            "required": false
        },
          "YOUTUBE_API_KEY": {
            "description": "YouTube Data API Key for .yt command. Get it from https://console.cloud.google.com",
            "required": false
        },
        "BIO_PREFIX": {
            "description": "Bot will add before song name. For both last.fm and spotify bio modules.",
            "required": false
        },
        "DEFAULT_BIO": {
            "description": "Default bio message.",
            "required": false
        },
        "WELCOME_MUTE": {
            "description": "Detect and mute spambots which match the Paperplane algorithm after they join a group. Use at your own risk, the algorithm is in beta stage.",
            "required": false
        },
        "KUTT_IT_API_KEY": {
            "description": "Link shortener. Take it from kutt.it",
            "required": false
        },
        "AUDIOTAG_API": {
            "description": "Audio recognition. Take it from audiotag.info.",
            "required": false
        },
        "GENIUS_API": {
            "description": "Lyrics module. Take ACCESS_TOKEN from https://genius.com/api-clients",
            "required": false
        },
        "WOLFRAM_ID": {
            "description": "Math module. Take it from wolframalpha.com",
            "required": false
        },
        "CONVERT_API": {
            "description": "For documents convertions module. Take it from https://www.convertapi.com/",
            "required": false
        },
        "GDRIVE_FOLDER": {
            "description": "Google Drive upload folder.",
            "required": false
        }
    }
}