Configuration

Phantasm starts with a sensible default configuration that you can override either by setting environment variables or by passing command-line arguments. This documentation will guide you through the available configuration options.

Receiver Authentication

Phantasm allows you to configure authentication for the communication between the client and the Receiver Server. Phantasm uses a simple secret key mechanism to authenticate the client, and by default, authentication is disabled.

To enable authentication, simply set the PHANTASM_SECRET environment variable to your secret key before starting the server. If you are running Phantasm in a Docker container, this is how you can set the secret key:

docker run -e PHANTASM_SECRET=secretkey ...

When authentication is enabled, you must provide the secret key when initializing the client to ensure that the client can authenticate and communicate with the Receiver Server.

Python

from phantasmpy import Phantasm
phantasm = Phantasm(secret="secretkey")

Auto Approval

There are times when an approver is not available to approve an action call. By default, Phantasm will return an error response with unavailable status code. If you want to automatically approve all actions when no approver is available, you can enable the auto-approval feature by setting the PHANTASM_AUTO_APPROVAL environment variable to true.

docker run -e PHANTASM_AUTO_APPROVAL=true ...

Warning

Enabling auto-approval is not recommended for production environments.