jw_shell_exec
jweiland/jw-shell-exec
main
en
Stefan Froemken
This document is published under the Creative Commons BY 4.0 license.
Wed, 10 Sep 2025 10:48:20 +0000
With jw_ you can execute just ONE configured shell script
from a TYPO3 BE module.
Table of Contents:
With jw_ you can configure just ONE shell script which
also non-admin BE users can execute (if he has rights to access the
BE module).
By default parallel execution of the script will be prevented, but as an administrator you still can allow parallel execution.
Let you BE users decide when it's time to start the configured backup script.
Add a possibility for your BE users to start the configured import script.
Set the shell script to show the last 3 lines of the TYPO3 log:
tail -n 3 /var/www/html/var/log/typo3_61d7538bf5.logSet the shell script to show the content of a file:
cat /var/www/html/index.phpIn most cases your BE users does not have access to scheduler module,
but with jw_ you can let your BE users execute a TYPO3
command:
typo3 scheduler:runSee jw_ in action.
This is an example output of the BE module of jw:. As you can
see there is no possibility for an editor to change the configured shell
script. There is just one button to execute the command and the job is done.
After execution you will see the command output.
By default it is not possible to execute a shell script, if another BE editor/admin is currently logged-in to TYPO3 BE. That prevents parallel executions of the shell script which may result into unwished side-effects.
Since version 3.0.0 you, as an admin, can activate parallel execution in extension settings
If your TYPO3 installation works in composer mode, please execute following command:
composer req jweiland/jw-shell-exec
vendor/bin/typo3 extension:setup --extension=jw_shell_execIf you work with DDEV please execute this command:
ddev composer req jweiland/jw-shell-exec
ddev exec vendor/bin/typo3 extension:setup --extension=jw_shell_execOn non composer based TYPO3 installations you can
install jw_ still over the ExtensionManager:
Login
Login to backend of your TYPO3 installation as an administrator or system maintainer.
Open ExtensionManager
Click on Extensions from the left menu to open the ExtensionManager.
Update Extensions
Choose Get Extensions from the upper selectbox and click on
the Update now button at the upper right.
Install jw_
Use the search field to find jw_. Choose
the jw_ line from the search result and click on the cloud
icon to install jw_.
Some general settings for jw_ can be configured
in Admin Tools -> Settings.
Default: pwd
Define a path to an executable shell script.
Note
If you want to execute OS commands like pwd with jw_ there
is no need to add full absolute path. jw_ will automatically
search in various PATHs like usr/, ...
Warning
$GLOBALS has to be
disabled. Else, the script will never be executed.
Warning
The EXT: prefix is not allowed anymore! Please register your shell
script with composer. That way it is automatically available from
vendor/ path. If you still need your own path
please add full absolute directory path to your shell script
in $GLOBALS and enter just the
filename of your script here.
Warning
Don't forget to set execution rights to your own shell script.
Default: false
To prevent side-effects when BE users have started the script at the same, the parallel execution is disabled by default. If you're sure that no side-effects will occure you can activate this option.
Visit BE Module
Click on JW Shell Exec from the left main menu in TYPO3 backend. It is
only visible, if an integrator has given you access to that BE module.
Execute
If you are the only user logged in into the TYPO3 BE you can now execute the defined shell script.