ServerConfig Schema

The ServerConfig schema defines the main configuration for the Rusty Beam server, including network settings, paths, and daemon behavior for production deployment.

Schema Definition

Schema URL: https://rustybeam.net/schema/ServerConfig

Properties

Property Type Required Default Description
serverRoot https://rustybeam.net/schema/Text Optional ./files The root directory from which static files are served
bindAddress https://rustybeam.net/schema/Text Optional 0.0.0.0 IP address to bind the server to
bindPort https://rustybeam.net/schema/Number Optional 3000 Port number to bind the server to
daemonPidFile https://rustybeam.net/schema/Text Optional /tmp/rusty-beam.pid Path to store the process ID file when running as daemon
daemonUser https://rustybeam.net/schema/Text Optional None Username to run daemon as (requires appropriate privileges)
daemonGroup https://rustybeam.net/schema/Text Optional None Group name or ID to run daemon as
daemonUmask https://rustybeam.net/schema/Text Optional 0o027 File creation mask in octal format (e.g., 0o027, 0o022)
daemonStdout https://rustybeam.net/schema/Text Optional /tmp/rusty-beam.stdout Path to redirect stdout when running as daemon
daemonStderr https://rustybeam.net/schema/Text Optional /tmp/rusty-beam.stderr Path to redirect stderr when running as daemon
daemonChownPidFile https://rustybeam.net/schema/Boolean Optional true Whether to change ownership of PID file to daemon user
daemonWorkingDirectory https://rustybeam.net/schema/Text Optional Config file directory Working directory for the daemon process

Example Configuration

<table itemscope itemtype="https://rustybeam.net/schema/ServerConfig">
    <tbody>
        <tr>
            <td>Server Root</td>
            <td><span itemprop="serverRoot">./docs</span></td>
        </tr>
        <tr>
            <td>Bind Address</td>
            <td><span itemprop="bindAddress">127.0.0.1</span></td>
        </tr>
        <tr>
            <td>Bind Port</td>
            <td><span itemprop="bindPort">3000</span></td>
        </tr>
        <tr>
            <td>Daemon PID File</td>
            <td><span itemprop="daemonPidFile">/var/run/rusty-beam.pid</span></td>
        </tr>
        <tr>
            <td>Daemon User</td>
            <td><span itemprop="daemonUser">www-data</span></td>
        </tr>
        <tr>
            <td>Daemon Group</td>
            <td><span itemprop="daemonGroup">www-data</span></td>
        </tr>
        <tr>
            <td>Daemon Umask</td>
            <td><span itemprop="daemonUmask">0o027</span></td>
        </tr>
        <tr>
            <td>Daemon Stdout</td>
            <td><span itemprop="daemonStdout">/var/log/rusty-beam.stdout</span></td>
        </tr>
        <tr>
            <td>Daemon Stderr</td>
            <td><span itemprop="daemonStderr">/var/log/rusty-beam.stderr</span></td>
        </tr>
    </tbody>
</table>
Security Note: When configuring daemonUser and daemonGroup, ensure the specified user has appropriate permissions to:
Production Deployment: For production use, consider:

Daemon Behavior

When the server is started without the -v flag, it runs in daemon mode using these settings:

See Also