-
Notifications
You must be signed in to change notification settings - Fork 10
Configuration
Melvin PETIT edited this page Jun 17, 2026
·
1 revision
Medusa is configured by convention and environment variables, there is no config file to edit. Settings are either chosen at startup (environment) or read from the shell.
In the interactive menu, press C to open a read-only system report covering:
- General — version, current user, working directory.
-
Environment — active environment name, tools directory, deployed-tool count (
installed/total), on-disk size. -
Docker — Docker version, daemon reachability, detected Compose command (
docker composevsdocker-compose). -
System tools — presence of
git,curl,python3,pip3,openssl,nmap,yara,oscap. - System — hostname, kernel, shell, total RAM, free disk space on the tools directory, environment count and total size.
This page changes nothing; it is a diagnostic snapshot. For prerequisites only, use ./medusa.sh check.
| Variable | Default | Effect |
|---|---|---|
ENV_NAME |
default (CLI) / chosen at startup (menu) |
Selects the deployment tree medusa_deployments/<ENV_NAME>/. See Environments. |
MEDUSA_HOME |
the script's own directory | Anchor for all absolute paths. Set automatically; override only if you know what you are doing. |
Example:
ENV_NAME=audit_client ./medusa.sh deploy keycloak| Path | Meaning |
|---|---|
$MEDUSA_HOME/medusa_deployments/ |
BASE_DIR, root of all environments |
$BASE_DIR/$ENV_NAME/ |
active environment (TOOLS_DIR) |
$TOOLS_DIR/<tool>/ |
one tool's compose file, .env, credentials.txt
|
$TOOLS_DIR/<tool>/.installed |
marker for CLI tools |
Each Docker tool's settings live in its generated docker-compose.yml (and .env when the upstream provides one). Edit those directly, then ./medusa.sh restart <tool>. Generated passwords are stored in credentials.txt (chmod 600).
Next: Environments · Security · Troubleshooting
Repository · Issues · Security policy · MIT License
Get running
Concepts
Tool catalog
Reference
Develop