⚠️ Deprecated ⚠️ OCCWeb terminal

Читать на русском.

A web terminal for admins to launch Nextcloud's occ commands

⚠️ Deprecated ⚠️

As nextcloudd has no native support for asynchronous operations, due to the use of php, this aplication is deprecated, and will no longer support the Nextcloud' future versions (19+). I did not find a way to implemement true support for interactive and long running occ tasks in a web terminal whitout introducing addtional dependencies (through websockets, for example), the lack of true asynchronous occ operations can lead to serious alterations of voluminous instances. This issue may give some hints on why I decided to not support this application anymore.

Install

No build step required (plain PHP + vanilla JS). Clone straight into the target server's apps/ directory and enable it:

cd /var/www/nextcloud/apps
git clone https://github.com/fanategorius/occweb.git
chown -R www-data:www-data occweb   # match your web server user
sudo -u www-data php /var/www/nextcloud/occ app:enable occweb

occ app:enable takes care of registering the app's version correctly, so none of the "Deploying updates" caveats below apply to a fresh install — they only matter once the app is already enabled and you're updating it in place.

Before installing, check your Nextcloud version against the range in appinfo/info.xml (dependencies/nextcloud, currently min-version/ max-version) — occ app:enable refuses to enable an app outside that range. If you're offline or without GitHub access, build a tarball instead with make dist (uses the included Makefile) and extract it into apps/ on the target server.

SQL query mode

Type sql in the terminal to switch into SQL query mode and run raw SQL statements directly against the Nextcloud database (admin only). Separate statements with ;. Use Shift+Enter to add a new line and Enter to run the whole block in a single request — this matters for scripts like SET vars.x = 'value'; SELECT current_setting('vars.x');, since every statement in one submission runs on the same database connection/session. Type occ to switch back to the normal occ-command mode.

⚠️ There is no undo for DELETE/UPDATE statements — double check what you are about to run, ideally against a non-critical row/user first.

⚠️ Warnings ⚠️

• The application is not a real interactive terminal and does not support long running tasks. So if your instance is pretty big, commands like occ files:scan will time out and fail.
• Do not use occ maintenance:mode --on, obvious...

Deploying updates

After pulling/copying new code into nextcloud/apps/occweb/, restart PHP so the changes actually take effect. occ app:disable/app:enable is not enough — it does not clear PHP's opcode cache, so a stale, cached version of the code can keep running (routes silently 404ing is a typical symptom). Restart the PHP process itself, for example:

sudo systemctl restart php8.3-fpm   # adjust to your installed PHP version
sudo systemctl restart apache2      # if PHP runs as an Apache module instead

If you bump the <version> in appinfo/info.xml

Nextcloud tracks each app's installed version in its database (installed_version in oc_appconfig) separately from the <version> in info.xml. If you edit files in place (copy/git pull) instead of going through the app store or occ upgrade, those two get out of sync — Nextcloud then treats the whole instance as "needs upgrade" and blocks most occ commands behind the CLI-upgrade wizard, even though nothing about Nextcloud core actually changed. After bumping the version, sync it manually:

sudo -u www-data php /var/www/nextcloud/occ config:app:set occweb installed_version --value="X.Y.Z"

(use the same X.Y.Z as the new <version>), then restart PHP as above. This does not apply on a fresh occ app:enable install — that command sets installed_version correctly on its own.

TODOs:

See open issues