Exit Documentation

discloud.config

Learn everything about the configuration file for hosting applications on Discloud.

📄 What is discloud.config and what is it used for?

It is a configuration file that streamlines the process of deploying your applications to Discloud. With this file, you can easily configure the information for each application you upload to the hosting service.

📂 Placement of the discloud.config File

✅ Correct Placement

The discloud.config file must be in the root of your project.

your-project/           # ← ROOT DIRECTORY
├── discloud.config     # ✅ REQUIRED HERE
├── package.json        # Example root file
├── src/                # Source code folder
│   └── index.js        # Main application file
├── .gitignore          # Config files
└── README.md           # Documentation

❌ Invalid Locations

These placements will cause deployment failures:

your-project/
├── src/
│   └── discloud.config   # ❌ SUBFOLDER ERROR
├── config/
│   └── discloud.config   # ❌ SUBFOLDER ERROR
└── .github/
    └── discloud.config   # ❌ HIDDEN FOLDER ERROR

🛠️ Configuration options

See below all the configuration options for the discloud.config file. Click here to check out some examples of different applications.

Define information for your application on the hosting platform, such as NAME and AVATAR. This allows you to easily identify your application on the dashboard or in the Visual Studio Code extension. See:

discloud.config
NAME=MyApp
AVATAR=https://i.imgur.com/bWhx7OT.png

  • NAME - determines the name of your application on the hosting platform.

  • AVATAR - uses the image URL as the avatar for your application on the hosting platform.

⚠️ Mandatory options in your discloud.config

Only one field is required:

MAIN=index.js

All other fields are optional and will use smart defaults if omitted:

  • TYPE defaults to bot

  • RAM defaults to 100 (MB)

  • VERSION defaults to latest

🪅 Examples of discloud.config files

See below examples of discloud.config files for 🤖 Discord Bots and 🌐 Websites and APIs.

Discord bot made in JavaScript where the entry point is the index.js file in the root of the project.

discloud.config
NAME=Lorito
TYPE=bot
MAIN=index.js
RAM=100
VERSION=latest

⚙️ Configuration options

The discloud.config file contains essential settings for your Discloud application. Below are the available configuration options along with their respective limits and descriptions.

Option
Limit / Values
Description

NAME

1 - 30 characters

The name of your application (used for display purposes).

AVATAR

Image URL (.gif, .jpeg, .jpg, .png)

A URL to the application's avatar. Supported formats: GIF, JPEG, JPG, PNG.

TYPE

bot / site

Defines whether the application is a bot or a website.

MAIN

Relative file path

Specifies the main file that should be executed in the project folder.

RAM

100 - 32000 MB

The amount of RAM allocated to the application (varies by plan).

VERSION

latest / current / suja / specific

Defines the versioning options for the environment and dependencies.

ID

User-defined subdomains

Custom subdomain for your application (for websites only).

BUILD

(Custom build commands)

If specified, defines commands to run before the application starts (e.g., installing dependencies).

START

(Custom start command)

Overrides the default start command to launch the application.

AUTORESTART

true / false

Determines whether the app should automatically restart if it crashes.

VLAN

true / false

Enables Virtual LAN (VLAN) for internal networking between applications.

HOSTNAME

(Custom hostname)

Specifies a custom hostname for the application.

APT

(List of packages)

Installs additional Linux dependencies required by your app. View available packages.

PreviousCLINextAPT

Last updated