Skip to content

Commit ab30ee7

Browse files
docs: add DOCKEREXE configuration section to README.md
1 parent 379e86d commit ab30ee7

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,32 @@ _concore_ supports customization through configuration files in the `CONCOREPATH
7777

7878
Tool paths can also be set via environment variables (e.g., `CONCORE_CPPEXE=/usr/bin/g++`). Priority: config file > env var > defaults.
7979

80+
### Docker Executable Configuration
81+
82+
The Docker executable used by generated scripts (`build`, `run`, `stop`, `maxtime`, `params`, `unlock`) is controlled by the `DOCKEREXE` variable. It defaults to `docker` and can be overridden in three ways (highest priority first):
83+
84+
1. **Config file** — Write the desired command into `concore.sudo` in your `CONCOREPATH` directory:
85+
```
86+
docker
87+
```
88+
This remains the highest-priority override, preserving backward compatibility.
89+
90+
2. **Environment variable** — Set `DOCKEREXE` before running `mkconcore.py`:
91+
```bash
92+
# Rootless Docker / Docker Desktop (macOS, Windows)
93+
export DOCKEREXE="docker"
94+
95+
# Podman
96+
export DOCKEREXE="podman"
97+
98+
# Traditional Linux with sudo
99+
export DOCKEREXE="sudo docker"
100+
```
101+
102+
3. **Default** — If neither the config file nor the environment variable is set, `docker` is used.
103+
104+
> **Note:** Previous versions defaulted to `sudo docker`, which failed on Docker Desktop (macOS/Windows), rootless Docker, and Podman. The new default (`docker`) works out of the box on those platforms. If you still need `sudo`, set `DOCKEREXE="sudo docker"` via the environment variable or `concore.sudo` config file.
105+
80106
### Security Configuration
81107

82108
Set a secure secret key for the Flask server before running in production:

0 commit comments

Comments
 (0)