Skip to content

installation.md

Latest commit

 

History

History
130 lines (89 loc) · 4.42 KB

installation.md

File metadata and controls

130 lines (89 loc) · 4.42 KB
Raw

Installation

This guide describes how to install IntroVox on a Nextcloud instance.

Requirements

  • Nextcloud 32 or later (32–34 explicitly supported as of v1.5.0)
  • PHP 8.1 or later

Verify the authoritative requirements in appinfo/info.xml.

Installation Methods

From the Nextcloud App Store (Recommended)

  1. Log in to your Nextcloud instance as an administrator
  2. Open Apps from the top-right menu
  3. Search for IntroVox
  4. Click Download and enable

Or go directly to apps.nextcloud.com/apps/introvox.

Manual Installation

  1. Download the latest release tarball from GitHub Releases
  2. Extract to your Nextcloud apps/ directory: 
    tar -xzf introvox-X.Y.Z.tar.gz -C /var/www/nextcloud/apps/
  3. Set correct ownership: 
    sudo chown -R www-data:www-data /var/www/nextcloud/apps/introvox
  4. Enable the app: 
    sudo -u www-data php occ app:enable introvox

From Source

For development or testing the latest unreleased changes:

git clone https://github.com/nextcloud/IntroVox.git /var/www/nextcloud/apps/introvox
cd /var/www/nextcloud/apps/introvox
npm install
npm run build
sudo -u www-data php occ app:enable introvox

Source-based installs require a node and npm toolchain on the server. For production, prefer the App Store or pre-built tarball.

Initial Configuration

After enabling the app:

  1. Go to Settings → Administration → IntroVox
  2. Toggle Enable wizard for all users — the tour is now live in every Nextcloud-supported language automatically (auto-translated via Transifex; English fallback for languages without a translation)
  3. Optionally open the Steps tab and click + Add language override to author custom copy for a specific language
  4. Optionally restrict steps to specific user groups for role-based onboarding

See Admin Guide for the full configuration walkthrough.

Restricting the App to Specific Groups

If you only want certain Nextcloud groups to see the wizard at all (and not just specific steps):

  1. Go to Settings → Apps → IntroVox
  2. Click "Limit to groups"
  3. Select the allowed groups

Users outside those groups won't have IntroVox's JavaScript loaded — the cleanest way to scope the app.

For finer control (different steps per group), see Group-Based Visibility.

Upgrading

Via the App Store

Upgrades appear in Settings → Apps → Updates when a new version is published. Click Update and Nextcloud handles the rest.

Manual Upgrade

  1. Download the new release tarball
  2. Disable the old version: 
    sudo -u www-data php occ app:disable introvox
  3. Replace the apps/introvox directory with the new tarball contents
  4. Re-enable: 
    sudo -u www-data php occ app:enable introvox

Migration Notes

IntroVox does not create or migrate custom database tables — all state lives in oc_appconfig and oc_preferences. Upgrades are non-destructive: custom step configurations, enabled languages, and user preferences are preserved.

The defensive is_array() guard in ApiController::getWizardSteps() (v1.4.3+) means that even if an older corrupt step blob exists, the wizard falls back to defaults rather than crashing.

Uninstallation

sudo -u www-data php occ app:disable introvox
sudo rm -rf /var/www/nextcloud/apps/introvox

The app-config and preferences rows can be left in place (harmless) or cleaned up:

DELETE FROM oc_appconfig WHERE appid = 'introvox';
DELETE FROM oc_preferences WHERE appid = 'introvox';

Verification

After installation:

  1. Log in as a regular user with an enabled language
  2. The wizard should auto-start on the dashboard after a few seconds
  3. Check Settings → Personal → IntroVox — the Restart tour now button should be visible

If the wizard doesn't appear, see Admin Troubleshooting.

See Also