Config — Volyx Documentation

Config overview

The Config page is split into several areas. Some settings describe your project, while others affect startup, runtime behavior, protection, notifications, and diagnostic information.

Use the live values shown by your server

Available runtimes, versions, detected project types, and some protection options can differ between servers. The values shown in your current Config page are the source of truth.

Bot Details

Bot Details contains the basic project information and recovery behavior for the server.

Bot Name

The display name used to identify the project or bot inside the server configuration.

Description

An optional short description that explains what the project does.

Auto Restart

Automatically attempts to recover the project after an unexpected crash when the feature is enabled.

Startup Delay

Adds a delay before startup. This can be useful when a project should not launch immediately after the server starts.

Runtime Environment

Runtime Environment controls which supported runtime and version Volyx uses for the project.

Runtime Type

Selects the runtime family used by the project, such as TypeScript, Node.js, Python, or another supported runtime.

Runtime Version

Selects the version of the chosen runtime.

Detected Project

Volyx can display the project type it detected from the files or project structure.

Test Runtime

Tests the selected runtime environment before you rely on it for normal project startup.

Changing runtime can affect startup

A project must be compatible with both the selected runtime type and version. After changing either value, restart the server and check Console for errors.

Smart Startup

Smart Startup helps Volyx determine how the project should be launched.

Smart Run

When enabled, Volyx can automatically detect and launch the project using the supported startup logic.

Main File

Specifies the primary entry file for your application when a particular file should be used.

Detected file type

Volyx can show the detected language or file type for the main file.

Use Auto Detect

Lets Volyx detect the appropriate startup entry automatically instead of relying only on a manually selected file.

For TypeScript projects, supported entry files can include .ts, .mts, and .cts.

Main File can be optional with Smart Run

When Smart Run is enabled, Volyx may be able to detect the startup file automatically. Use a manual Main File when you need to explicitly control the project entry point.

Crash Protection

Crash Protection helps prevent a broken project from repeatedly crashing and immediately restarting without control.

Crash Loop Protection

Detects repeated crashes and can pause automatic recovery when the application keeps failing.

Crash Limit

Defines how many crashes can occur before Volyx treats the behavior as a crash loop.

Detection Window

Defines the time window used to count repeated crashes.

Auto Restart interaction

Crash Loop Protection works together with automatic recovery so a failing application does not restart forever.

Crash protection does not fix the application error

If the project repeatedly crashes, inspect Console and fix the underlying error. Crash protection only controls repeated recovery behavior.

Discord Notifications

Discord Notifications lets the server send selected events to a Discord webhook.

Discord Webhook URL

Enter the Discord webhook used for notifications. The interface can display whether the webhook is connected.

Keep webhook URLs private

A Discord webhook URL acts like a credential. Do not publish it in screenshots, public repositories, or support messages.

Lifecycle events

You can choose which server lifecycle events should send a notification.

Started

Server or project startup.

Stopped

Server or project shutdown.

Restarted

Restart event.

Crashed

Unexpected project crash.

Crash Loop

Repeated crash-loop detection.

Auto Recovery

Automatic recovery action.

Bot Ready

Supported project-ready event.

Runtime events

Runtime Changed

Runtime configuration changed.

Smart Run Detected

Smart Run detected the project startup configuration.

Smart Run Failed

Smart startup detection or execution failed.

Main File Changed

The configured application entry file changed.

Monitoring events

CPU / Memory / OOM

Resource or out-of-memory related events when supported.

Settings Changed

Selected server configuration changes.

Secret Updated

Notification when a supported Secret change occurs.

Webhook tools

The Discord notification area also includes tools for checking the webhook before relying on it.

Preview Webhook

Selects an event type to preview.

Send Preview

Sends a preview notification to the configured webhook.

Test Webhook

Tests whether the configured webhook can be reached.

Remove Webhook

Removes the currently saved webhook from the configuration.

Last Start Info

Last Start Info summarizes what happened during the most recent startup or recovery attempt.

Status

Shows whether the server or application is currently online or in another state.

Runtime

Shows the runtime used for the last start.

Uptime

Shows how long the current running session has lasted.

Started By

Shows what triggered the startup, such as normal server startup or an automatic recovery action.

Detected Project

Shows the project type detected during startup.

Last Crash

Shows the recorded time of the last crash when one exists.

Crash Reason

Summarizes why the previous process stopped when that information is available.

Exit Code

Shows the application's exit code from the previous process.

Auto Recovery

Shows whether automatic recovery is currently enabled.

Use Last Start Info together with Console

Last Start Info provides a summary. Console usually contains the detailed log output needed to understand the actual application error.

Changing Config safely

Change one major setting at a time.
Save the configuration before restarting.
Check Console immediately after a runtime or startup change.
Verify the Main File exists before setting it manually.
Keep webhook URLs and project credentials private.
Use Last Start Info when diagnosing repeated crashes.

Next step

Continue with Settings to configure the server interface, preferred file editor, navigation, plan options, renewal, and server management actions.