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

# Coral Console

export const ServerConfigSingle = ({table, config, example}) => {
  let hyphens = config.replace(/[A-Z]/g, letter => `-${letter.toLowerCase()}`);
  let underscores = config.replace(/[A-Z]/g, letter => `_${letter.toLowerCase()}`);
  return <CodeGroup>
            <CodeBlock filename="Command line">
                <span>--{table}.{hyphens}={example}</span>
            </CodeBlock>

            <CodeBlock filename="Config file">
                <span>{table}.{underscores} = {example}</span>
            </CodeBlock>
        </CodeGroup>;
};

# Enable console

<Badge color="blue">default</Badge> `true` <br />

<ServerConfigSingle table="console" config="enabled" example="true" />

If this is set to `false`, the Coral server will not serve the Coral console at `/ui/console`. Consider disabling this
in production environments.

# Cache path

<Badge color="blue">default</Badge> `${HOME}/.coral/console` <br />

<ServerConfigSingle table="console" config="cachePath" example="&#x22;/my/custom/path&#x22;" />

The path that the Coral console will be downloaded to. Note: this directory should not contain anything but Coral
console files. This directory may be deleted by the Coral server when the Coral console is updated.

# Console release URL

<Badge color="blue">default</Badge> `https://github.com/Coral-Protocol/coral-studio/releases/download` <br />

<ServerConfigSingle table="console" config="consoleReleaseUrl" example="&#x22;https://github.com/fork-user/console/releases/download&#x22;" />

The path that the Coral console versions will be downloaded from. This should only be changed if using a fork of the
Coral console.

# Console release version

<Badge color="blue">default</Badge> stable Console version for given Coral server version <br />

<ServerConfigSingle table="console" config="consoleReleaseVersion" example="&#x22;1.1.1-beta&#x22;" />

The name of the Coral console version to download. This can be changed to use beta versions of the Coral console.

<Warning>
  Not all Coral console versions are compatible with all Coral server versions. If you change this, ensure that the
  selected Coral console version remains compatible when performing Coral server upgrades.
</Warning>

# Bundle name

<Badge color="blue">default</Badge> `coral-console_${consoleReleaseVersion}.zip` <br />

<ServerConfigSingle table="console" config="bundleName" example="&#x22;1.1.1-beta&#x22;" />

The name of the bundle to download. Note that if this is changed, the [console release version](#console-release-version)
will have no effect.

# Delete old versions

<Badge color="blue">default</Badge> `false` <br />

<ServerConfigSingle table="console" config="deleteOldVersions" example="true" />

If this is `true`, the Coral server will delete old versions of the Coral console when it starts.

# Always download

<Badge color="blue">default</Badge> `false` <br />

<ServerConfigSingle table="console" config="alwaysDownload" example="true" />

If this is true, the Coral server will always download the latest version of the Coral console even if it is already
downloaded. This can be used if a forked version of the Coral console opts to update an existing version.