> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# How to Host a Discord Bot 24/7

> Host your Discord bot 24/7 on Square Cloud: create the token, write a discord.js or discord.py bot, deploy it and keep it online.

export const RecommendedPlan = ({lang, plan, tier, cpu, appType, min}) => {
  const t = {
    'en': {
      q: <>Which plan should you choose for {appType}?</>,
      rec: p => <>We recommend the {p} plan: its <b>{tier} GB</b> of RAM and <b>{cpu} vCPU</b> handle most projects of this kind, with headroom for traffic spikes.</>,
      min: m => <> Lighter projects also run on the {m} plan.</>,
      pro: p => <> For larger projects, the {p} plan adds more RAM and CPU.</>
    },
    'pt-br': {
      q: <>Qual plano escolher para {appType}?</>,
      rec: p => <>Recomendamos o plano {p}: seus <b>{tier} GB</b> de RAM e <b>{cpu} vCPU</b> atendem a maioria dos projetos desse tipo, com folga para picos de tráfego.</>,
      min: m => <> Projetos mais leves também rodam no plano {m}.</>,
      pro: p => <> Para projetos maiores, o plano {p} oferece mais RAM e CPU.</>
    },
    'es': {
      q: <>¿Qué plan elegir para {appType}?</>,
      rec: p => <>Te recomendamos el plan {p}: sus <b>{tier} GB</b> de RAM y <b>{cpu} vCPU</b> cubren la mayoría de los proyectos de este tipo, con margen para picos de tráfico.</>,
      min: m => <> Los proyectos más ligeros también funcionan en el plan {m}.</>,
      pro: p => <> Para proyectos más grandes, el plan {p} ofrece más RAM y CPU.</>
    },
    'fr': {
      q: <>Quel plan choisir pour héberger {appType} ?</>,
      rec: p => <>Nous recommandons le plan {p} : ses <b>{tier} Go</b> de RAM et <b>{cpu} vCPU</b> suffisent pour la plupart des projets de ce type, avec une marge pour les pics de trafic.</>,
      min: m => <> Les projets plus légers fonctionnent aussi avec le plan {m}.</>,
      pro: p => <> Pour les projets plus importants, le plan {p} offre davantage de RAM et de CPU.</>
    },
    'de': {
      q: <>Welcher Plan eignet sich für {appType}?</>,
      rec: p => <>Wir empfehlen den {p}-Plan: <b>{tier} GB</b> RAM und <b>{cpu} vCPU</b> reichen für die meisten Projekte dieser Art, mit Reserven für Lastspitzen.</>,
      min: m => <> Kleinere Projekte laufen auch mit dem {m}-Plan.</>,
      pro: p => <> Für größere Projekte bietet der {p}-Plan mehr RAM und CPU.</>
    },
    'it': {
      q: <>Quale piano scegliere per {appType}?</>,
      rec: p => <>Ti consigliamo il piano {p}: i suoi <b>{tier}GB</b> di RAM e <b>{cpu}vCPU</b> bastano per la maggior parte dei progetti di questo tipo, con margine per i picchi di traffico.</>,
      min: m => <> I progetti più leggeri funzionano anche con il piano {m}.</>,
      pro: p => <> Per progetti più grandi, il piano {p} offre più RAM e CPU.</>
    },
    'ja': {
      q: <>{appType}にはどのプランを選べばよいですか？</>,
      rec: p => <>{p}プランをおすすめします。<b>{tier}GB</b>のRAMと<b>{cpu}vCPU</b>があれば、この種のプロジェクトの多くをトラフィックのピークにも余裕を持って動かせます。</>,
      min: m => <>軽量なプロジェクトは{m}プランでも動作します。</>,
      pro: p => <>より大規模なプロジェクトには、RAMとCPUが増える{p}プランをご検討ください。</>
    },
    'zh': {
      q: <>托管{appType}应该选择哪个套餐？</>,
      rec: p => <>我们推荐 {p} 套餐：<b>{tier}GB</b> RAM 和 <b>{cpu}vCPU</b> 足以运行大多数此类项目，并能从容应对流量高峰。</>,
      min: m => <>较轻量的项目也可以在 {m} 套餐上运行。</>,
      pro: p => <>对于更大的项目，{p} 套餐提供更多 RAM 和 CPU。</>
    }
  };
  const siteLang = t[lang] ? lang : 'en';
  const c = t[siteLang];
  const pay = (name, query) => <a href={`https://squarecloud.app/${siteLang}/pay?${query}`}>{name}</a>;
  const isPro = plan.toLowerCase() === 'pro';
  return <Note>
      <b>{c.q}</b><br />
      {c.rec(pay(plan, `plan=${plan.toLowerCase()}&tier=${tier}`))}
      {min ? c.min(pay(min, `plan=${min.toLowerCase()}`)) : null}
      {isPro ? null : c.pro(pay('Pro', 'plan=pro'))}
    </Note>;
};

export const appType_0 = "a Discord bot"

## Introduction

To develop and host {appType_0} on Square Cloud, it's essential to follow a structured sequence of configurations and prerequisites. This technical guide will cover the entire process, from initial setup to production deployment.

### Prerequisites

* **Square Cloud Account**: Register through the [signup page](https://squarecloud.app/en/signup) using your email.
* **Active plan**: Ensures dedicated resources and optimized performance for your application. Check our [available plans](https://squarecloud.app/en/pricing) and choose the most suitable for your needs.

<RecommendedPlan appType="Discord bots" plan="Standard" tier="4" cpu="4" min="Hobby" lang="en" />

This guide runs on the [Node.js runtime](/en/articles/getting-started-with-nodejs) or the [Python runtime](/en/articles/getting-started-with-python).

## Create the project

You need a Discord account to create and manage bots. If you don't have one, create it on the [official Discord website](https://discord.com/).

### Bot application on Discord

<Steps>
  <Step title="Create the application" icon="rocket" iconType="solid">
    Access the [Developer Portal](https://discord.com/developers/applications) and click "New Application". Define a name for your bot and click "Create" to create the application.

    <Frame>
      <img src="https://cdn.squarecloud.app/docs/articles/discord/create-an-application.webp" alt="Creating a Discord application in Developer Portal" style={{ borderRadius: "0.2rem" }} />
    </Frame>
  </Step>

  <Step title="Generate the token" icon="key" iconType="solid">
    After creating the application, navigate to the "Bot" tab and click "Reset Token" to generate the authentication token. Copy it: you will set it as an environment variable on Square Cloud, never in your code.

    <Frame>
      <img src="https://cdn.squarecloud.app/docs/articles/discord/generating-token.webp" alt="Generating Discord bot authentication token" style={{ borderRadius: "0.2rem" }} />
    </Frame>
  </Step>

  <Step title="Turn on the privileged intents" icon="message" iconType="solid">
    The example bot reads the text of messages, so it needs the **Message Content Intent**. Stay in the "Bot" tab, scroll down to "Privileged Gateway Intents" and turn on **Message Content Intent**. This example doesn't need the other two privileged intents (Presence and Server Members).

    <Frame>
      <img src="https://cdn.squarecloud.app/docs/articles/discord/intent.webp" alt="Enabling Discord privileged gateway intents" style={{ borderRadius: "0.2rem" }} />
    </Frame>
  </Step>
</Steps>

<Warning>
  **Keep your token secret**: this token grants total control over the bot. Never write it in your code or put it in your ZIP: the examples below read it from the `DISCORD_TOKEN` environment variable.
</Warning>

## Develop the bot

Write the bot with discord.js (Node.js) or discord.py (Python):

<Tabs>
  <Tab title="Discord.js (Node.js)">
    1. Verify that Node.js is installed on your system. If not, download it from the [official Node.js website](https://nodejs.org/).

    2. Initialize a new Node.js project:

    ```bash Terminal theme={"system"}
    npm init -y
    ```

    3. Install the discord.js library:

    ```bash Terminal theme={"system"}
    npm install discord.js
    ```

    4. Create a JavaScript file (e.g., `index.js`) and add the following code to create a basic Discord bot:

    ```javascript index.js theme={"system"}
    const { Client, Events, GatewayIntentBits } = require("discord.js");

    const client = new Client({
      intents: [
        GatewayIntentBits.Guilds,
        GatewayIntentBits.GuildMessages,
        // Privileged: turn on "Message Content Intent" in the Developer Portal
        GatewayIntentBits.MessageContent,
      ],
    });

    client.once(Events.ClientReady, (readyClient) => {
      console.log(`Logged in as ${readyClient.user.tag}`);
    });

    client.on(Events.MessageCreate, (message) => {
      if (message.author.bot) return;
      if (message.content === "!hello") {
        message.reply("Hello!");
      }
    });

    // The token comes from the DISCORD_TOKEN environment variable
    client.login(process.env.DISCORD_TOKEN);
    ```

    The code uses discord.js v14, where the ready event is `Events.ClientReady` (`"clientReady"`). The old `"ready"` name is deprecated.
  </Tab>

  <Tab title="Discord.py (Python)">
    1. Verify that Python is installed on your system. If not, download it from the [official Python website](https://www.python.org/).

    2. Install the discord.py library using pip:

    ```bash Terminal theme={"system"}
    pip install discord.py
    ```

    3. Create a Python file (e.g., `main.py`) and add the following code to create a basic Discord bot:

    ```python main.py theme={"system"}
    import os

    import discord
    from discord.ext import commands

    intents = discord.Intents.default()
    # Privileged: turn on "Message Content Intent" in the Developer Portal
    intents.message_content = True

    bot = commands.Bot(command_prefix="!", intents=intents)


    @bot.event
    async def on_ready():
        print(f"Logged in as {bot.user}")


    @bot.command()
    async def hello(ctx):
        await ctx.reply("Hello!")


    # The token comes from the DISCORD_TOKEN environment variable
    bot.run(os.environ["DISCORD_TOKEN"])
    ```

    4. Create a `requirements.txt` file to list all external libraries needed for your project:

    ```txt requirements.txt theme={"system"}
    discord.py
    ```
  </Tab>
</Tabs>

## Configure Square Cloud

Create a `squarecloud.app` file at the root of your project, next to your main file. It tells Square Cloud how to run your bot:

<CodeGroup>
  ```systemd Discord.js theme={"system"}
  DISPLAY_NAME=My Discord Bot
  MAIN=index.js
  MEMORY=512
  VERSION=recommended
  AUTORESTART=true
  ```

  ```systemd Discord.py theme={"system"}
  DISPLAY_NAME=My Discord Bot
  MAIN=main.py
  MEMORY=512
  VERSION=recommended
  AUTORESTART=true
  ```
</CodeGroup>

* `MAIN` is the file Square Cloud runs, and `MEMORY` is the bot's RAM in MB. Bots need at least 256 MB; 512 MB leaves room to grow.
* `AUTORESTART=true` starts the bot again if it crashes. See [how auto restart works](https://help.squarecloud.app/en-us/article/how-to-use-auto-restart-on-square-cloud-nmhvh0/).
* There is no `SUBDOMAIN`: a bot doesn't serve web pages.

When you upload from the dashboard, the upload form can fill in these settings for you. See the [configuration file reference](/en/getting-started/config-file) for every field.

## Set the bot token

Your code reads the token from the `DISCORD_TOKEN` environment variable, so the token never goes into your files. Set it in one of these ways:

* **Dashboard**: on the upload page, open **Advanced configuration** and add a variable named `DISCORD_TOKEN` with your token as the value. For a bot that is already deployed, add it on the application's **Environment Variables** page and restart the bot.
* **CLI**: right after you upload the bot (see [Deploy and verify](#deploy-and-verify)), set it with [`squarecloud app env set`](/en/cli-reference/environment-variables#squarecloud-app-env-set) and restart the bot:

```bash theme={"system"}
squarecloud app env set DISCORD_TOKEN=your_token_here
squarecloud app restart
```

The bot reads its environment variables when it starts, so restart it after every change. See [Environment variables](/en/platform/environment-variables) for the other ways to manage them.

<Tip>To run the bot on your computer first, set the variable in your terminal: `export DISCORD_TOKEN=your_token_here` on macOS and Linux, or `$env:DISCORD_TOKEN="your_token_here"` in PowerShell.</Tip>

## What goes in the ZIP

* Your main file (`index.js` or `main.py`) and your other source files.
* `package.json` or `requirements.txt`.
* `squarecloud.app`.

Leave out `node_modules`, `.venv` and `__pycache__`: Square Cloud installs your dependencies when the bot starts.

## Deploy and verify

Create the ZIP described above, then upload it:

### Via dashboard

<Steps>
  <Step title="Access the Upload Page">
    Access the [upload page](https://squarecloud.app/en/dashboard/new) and upload your project zip file.
  </Step>

  <Step title="Configure Your Environment">
    After uploading your zip, you will need to configure the name, main file or runtime environment and other settings for your project.\
    If you are uploading a web project, make sure to select "Web Publication" and set a subdomain to your project.
  </Step>

  <Step title="Deploy Your Project">
    Finally, click on the "Deploy" button to host your project on Square Cloud.\
    After deployment, you can monitor your project's status and logs from the dashboard.

    <Frame>
      <img src="https://cdn.squarecloud.app/docs/articles/dashboard/uploading.gif" alt="Uploading application to Square Cloud" style={{ borderRadius: "0.2rem" }} />
    </Frame>
  </Step>

  <Step title="Confirm Your App Is Live">
    Your first deploy usually takes less than a minute. In the [dashboard](https://squarecloud.app/en/dashboard), wait for your application status to show as running and check the logs for any startup errors.\
    If you deployed a website or API, open `https://<your-subdomain>.squareweb.app` in your browser: you should see your application responding. If you deployed a bot, send it a command to confirm it is online.
    <Tip>App not starting? See the [Troubleshooting guide](/en/platform/troubleshooting/app-wont-start) for the most common causes and fixes.</Tip>
  </Step>
</Steps>

### Via CLI

To use this method, your project needs a configuration file named `squarecloud.app` at its root. It tells Square Cloud how to run your application.

<Card title="Configuration file guide" icon="link" href="/en/getting-started/config-file">
  Learn how to create the `squarecloud.app` configuration file that defines your application's environment.
</Card>

<Steps>
  <Step title="Install the CLI">
    Install the [Square Cloud CLI](/en/cli-reference/installation). If you already have it, run the same command to update it:

    <CodeGroup>
      ```bash macOS, Linux, and WSL theme={"system"}
      curl -fsSL https://cli.squarecloud.app/install | bash
      ```

      ```bash Windows with npm theme={"system"}
      npm install -g @squarecloud/cli@latest
      ```
    </CodeGroup>
  </Step>

  <Step title="Log In">
    Run the command below. It opens your browser: approve the login there and the CLI is ready. There is no API key to copy. For scripts and CI, see [CLI authentication](/en/cli-reference/authentication).

    ```bash theme={"system"}
    squarecloud auth login
    ```
  </Step>

  <Step title="Upload Your Project">
    From your project folder, run the command below. The CLI zips the current folder, leaving out what [`squarecloud.ignore`](/en/getting-started/squarecloud-ignore) lists, and uploads it:

    ```bash theme={"system"}
    squarecloud upload
    ```

    To upload a zip you created yourself, pass it with `--file`:

    ```bash theme={"system"}
    squarecloud upload --file <path/to/zip>
    ```
  </Step>

  <Step title="Confirm Your App Is Live">
    Your first deploy usually takes less than a minute. Check your application status and logs directly from the terminal:

    ```bash theme={"system"}
    squarecloud app status
    squarecloud app logs
    ```

    If you deployed a website or API, open `https://<your-subdomain>.squareweb.app` in your browser: you should see your application responding. If you deployed a bot, send it a command to confirm it is online.
    <Tip>App not starting? See the [Troubleshooting guide](/en/platform/troubleshooting/app-wont-start) for the most common causes and fixes.</Tip>
  </Step>
</Steps>

### Invite the bot to your server

To send the bot a command, add it to a Discord server:

1. Access the [Developer Portal](https://discord.com/developers/applications) and select your bot.
2. Navigate to the "OAuth2" tab and go to "OAuth2 URL Generator".
3. Under "Scopes", check the "bot" option.
4. Under "Bot Permissions", check only what the example needs: **View Channels**, **Send Messages** and **Read Message History**. Avoid **Administrator**: bots rarely need it, and a leaked token would then control your whole server.
5. Copy the generated URL, open it in your browser and add the bot to your server. The URL looks like this:

```txt theme={"system"}
https://discord.com/oauth2/authorize?client_id=YOUR_CLIENT_ID&permissions=68608&scope=bot
```

`68608` is the sum of those three permissions. Replace `YOUR_CLIENT_ID` with your application's ID, shown on the "General Information" tab. If you add commands that need more permissions, generate a new URL with them checked.

Then send `!hello` in a channel the bot can see. It replies with `Hello!`.

<Frame>
  <img src="https://cdn.squarecloud.app/docs/articles/discord/testing-bot.gif" alt="Testing the Discord bot after deployment" style={{ borderRadius: "0.2rem" }} />
</Frame>

## Common errors

### An invalid token was provided

The logs show `Error [TokenInvalid]: An invalid token was provided.` (discord.js) or `discord.errors.LoginFailure: Improper token has been passed.` (discord.py). The `DISCORD_TOKEN` variable is missing or holds an old token. Copy the current token from the "Bot" tab, set it again and restart the bot. With discord.py, a `KeyError: 'DISCORD_TOKEN'` means the variable is not set at all.

### Used disallowed intents

The logs show `Error [DisallowedIntents]: Privileged intent provided is not enabled or whitelisted.` (discord.js) or `discord.errors.PrivilegedIntentsRequired` (discord.py). The code asks for the Message Content Intent, but it is off in the Developer Portal. Turn it on in the "Bot" tab, as in [Bot application on Discord](#bot-application-on-discord), then restart the bot.

### The bot is online but doesn't answer `!hello`

Check that the bot can view and send messages in that channel, and that the Message Content Intent is on: without it, the bot receives messages with empty text.

For more messages and fixes, see [Discord bot errors](/en/platform/troubleshooting/discord-bot-errors).

## Next steps

<CardGroup cols={3}>
  <Card title="Discord bot errors" icon="triangle-exclamation" href="/en/platform/troubleshooting/discord-bot-errors">
    Fix an invalid token, missing intents and other common errors.
  </Card>

  <Card title="Environment variables" icon="key" href="/en/platform/environment-variables">
    Manage your bot's token and other secrets.
  </Card>

  <Card title="Lavalink server" icon="music" href="/en/tutorials/how-to-create-your-lavalink-server">
    Host a Lavalink server to play music in your bot.
  </Card>
</CardGroup>

For more about these libraries, see the [official discord.py documentation](https://discordpy.readthedocs.io/en/latest/) and the [official discord.js guide](https://discordjs.guide/).

## Contact us

If you continue facing **technical difficulties**, our **specialized support team** is available to assist you. [**Contact us**](https://squarecloud.app/en/support) and we'll be happy to help you resolve any issue: support quality is a big part of why developers rate Square Cloud [**4.9/5 across 402 reviews**](https://www.trustpilot.com/review/squarecloud.app) on Google and Trustpilot.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.