Repository navigation
Administration
This page is for Nextcloud administrators. Everything is configured in Administration settings → Quantum Chess. The full reference, including privacy and security, is in the README.
Requirements: Nextcloud 32 to 35 on 64-bit PHP 8.1 or later, with any database Nextcloud supports. There are no other server dependencies.
From the App Store (recommended): Apps → Games → Quantum Chess → Download and enable, or
occ app:install quantumchess.
Manually: download quantumchess-vX.Y.Z.tar.gz from the
releases (it is signed, so the integrity check accepts it),
then:
tar -xzf quantumchess-vX.Y.Z.tar.gz -C /var/www/nextcloud/custom_apps
chown -R www-data:www-data /var/www/nextcloud/custom_apps/quantumchess
sudo -u www-data php occ app:enable quantumchessCorrespondence games need a clock. A background job runs every 15 minutes: it expires unanswered invitations and open challenges, ends games whose move deadline passed, deletes old chat and cleans up.
- Use Cron as the background job mode, with the system cron calling
cron.phpevery 5 minutes. - With AJAX or Webcron the app still behaves correctly, because deadlines are also checked whenever a game is opened. The Diagnostics section of the admin page shows the mode.
| Setting | Default | |
|---|---|---|
| Online play on or off, and for which groups | on, everyone | Users outside the groups can still play locally |
| Open challenges | on | |
| Rated games | on | Elo ratings and the leaderboard |
| Invitation / open challenge expiry | 14 / 7 days | |
| Active games per user | 30 | |
| Chat, and how long chat is kept | on, 90 days after the game | |
| Delete finished games after | never | Optional, 30 days or more |
| Leaderboard | opt-in | Off, opt-in or opt-out |
For instant moves, install the Nextcloud app Client Push (notify_push). A distributed cache (for example Redis) is recommended.
Three sources can be offered to users; the built-in computer player takes over whenever an AI does not answer in time.
-
Nextcloud AI (Assistant / TaskProcessing). Install a text-generation provider such as OpenAI and LocalAI
integration or Local large language model. Run a TaskProcessing worker, or an AI move can take up to five
minutes:
sudo -u www-data php occ background-job:worker -t 60 'OC\TaskProcessing\SynchronousBackgroundJob' - Organisation provider: one provider with a shared key for everybody or for chosen groups, with a daily request cap and a list of allowed models. Use Test connection and Load models. The key is stored encrypted.
- Personal keys: allow users to add their own provider and key.
Requests to local and private addresses (localhost, private networks, *.local) are blocked by default. To use, say,
an Ollama server in your network, allow a local address for the organisation provider, or add exact base URLs to the
local server allow-list for personal providers.
Further limits: AI requests per user and hour (60 by default), the maximum answer length, and an optional text for the first-use notice, for example a link to your AI policy. Details are in the README.
Quantum Chess makes no requests to external services except the AI provider you or your users configure: no CDNs, no external fonts, no telemetry. The data inventory for your records of processing activities is in the README.
Players
- Getting started
- How to play
- Playing online
- Computer and AI opponents
- Trainer and review
- Chess variants
- Settings
- FAQ
Administrators
More