Installatie¶
Deze gids beschrijft hoe je IntroVox installeert op een Nextcloud-instantie.
Vereisten¶
- Nextcloud 32 tot en met 35 (35 sinds v1.7.7)
- PHP 8.1 of later
Verifieer de gezaghebbende vereisten in appinfo/info.xml.
Installatie-methodes¶
Via de Nextcloud-App-Store (aanbevolen)¶
- Log in op je Nextcloud-instantie als beheerder
- Open Apps via het rechtsboven-menu
- Zoek naar IntroVox
- Klik op Download en inschakelen
Of ga direct naar apps.nextcloud.com/apps/introvox.
Handmatige installatie¶
- Download de laatste release-tarball van GitHub Releases
- Pak uit in je Nextcloud-
apps/-directory:
- Stel correct eigenaarschap in:
- Schakel de app in:
Vanuit source¶
Voor development of testen van de laatste niet-gereleasede wijzigingen:
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 vereisen een
node- ennpm-toolchain op de server. Voor productie, gebruik bij voorkeur de App Store of pre-built tarball.
Initiële configuratie¶
Na het inschakelen van de app hoeft er voor de welkomsttour niets aan:
- Tours for everyone staat na de installatie aan, dus de welkomsttour start voor elke gebruiker bij de volgende paginalading, in de eigen taal (vertaald via Transifex; Engels voor een taal zonder vertaling)
- Tours verschijnt in het gebruikersmenu van iedereen, net boven Help; verberg het onder Settings (Show Tours in the user menu)
- Tours voor apps en pagina's, de ingebouwde tours voor Files, Talk, Deck en Calendar, en de checklist op het Dashboard staan uit tot je ze aanzet
- De eerste keer dat je Instellingen → Beheer → IntroVox opent, laat een korte beheerderstour je de pagina zien. Hij sluit af met de vraag over telemetrie; een instantie stuurt geen telemetrie tot een beheerder die vraag gezien heeft
Daarna eventueel:
- Open Tours, klik bij de Welcome tour op Edit steps en klik op Add language override om voor een taal eigen tekst te schrijven
- Beperk stappen tot gebruikersgroepen voor rol-gebaseerde onboarding
- Zet een ingebouwde tour aan, of voeg een eigen tour toe met Tours → New tour (Tours)
Zie Beheerdersgids voor de volledige configuratie-walkthrough.
De app beperken tot specifieke groepen¶
Als je alleen bepaalde Nextcloud-groepen de wizard wilt laten zien (en niet alleen specifieke stappen):
- Ga naar Instellingen → Apps → IntroVox
- Klik op "Beperken tot groepen"
- Selecteer de toegestane groepen
Gebruikers buiten die groepen krijgen IntroVox' JavaScript niet geladen — de schoonste manier om de app te scopen.
Voor fijnere controle (verschillende stappen per groep), zie Groep-gebaseerde zichtbaarheid.
Upgraden¶
Via de App-Store¶
Upgrades verschijnen in Instellingen → Apps → Updates wanneer een nieuwe versie wordt gepubliceerd. Klik op Updaten en Nextcloud regelt de rest.
Handmatige upgrade¶
- Download de nieuwe release-tarball
- Schakel de oude versie uit:
- Vervang de
apps/introvox-directory met de nieuwe tarball-inhoud - Schakel weer in:
Bijwerken naar 2.0.0¶
2.0.0 verandert wat een update vanzelf doet. Lees de Upgrade notes in de changelog van 2.0.0 voor je bijwerkt; in het kort:
- De persoonlijke schakelaar "tour uitzetten" heet nu Start tours by themselves en geldt voor elke tour. De repair-step
IntroduceTourszet tours uit voor wie de welkomsttour had uitgezet zonder hem af te maken - Nieuwe functies (tours voor apps, ingebouwde tours, de checklist) staan uit; Tours in het gebruikersmenu is de uitzondering
- Telemetrie wacht tot een beheerder de instellingen van IntroVox heeft geopend en de vraag heeft gezien
- Scripts die de routes van IntroVox direct aanroepen moeten misschien worden aangepast: drie stap-routes zijn weg, en elke route op twee na vraagt het CSRF-request-token
Migratie-opmerkingen¶
IntroVox maakt of migreert geen eigen database-tabellen. Instellingen, tours en hun stappen staan in oc_appconfig, gebruikers-voorkeuren in oc_preferences. De afbeeldingen en video's van stappen, en de back-ups van de laatste tien verwijderde tours, staan in de app-datamap van IntroVox (appdata_<instanceid>/introvox in de datamap van Nextcloud). Upgrades zijn niet-destructief: tours, stappen, overrides per taal, media en gebruikers-voorkeuren blijven behouden.
De defensieve is_array()-guard in TourRepository::steps() betekent dat zelfs als een oudere corrupte stap-blob bestaat, de tour terugvalt op de standaardstappen in plaats van crashen.
Deïnstallatie¶
Staat Put it on every Dashboard aan voor de checklist, zet het dan eerst uit: tot dan noemt de standaardindeling van het Dashboard (app-config dashboard / layout) introvox-checklist.
De app-config- en preferences-rijen kunnen blijven staan (onschadelijk) of opgeruimd worden:
DELETE FROM oc_appconfig WHERE appid = 'introvox';
DELETE FROM oc_preferences WHERE appid = 'introvox';
De afbeeldingen en video's van stappen en de back-ups van verwijderde tours blijven in de app-datamap staan. Wil je die ook kwijt, verwijder hem dan en laat Nextcloud de bestanden vergeten:
sudo rm -rf /var/www/nextcloud/data/appdata_<instanceid>/introvox
sudo -u www-data php occ files:scan-app-data
<instanceid> is de instanceid in config/config.php; de datamap kan ergens anders staan dan /var/www/nextcloud/data.
De app uitgeschakeld terwijl Put it on every Dashboard nog aan stond? Haal introvox-checklist dan met de hand uit de indeling:
sudo -u www-data php occ config:app:get dashboard layout
sudo -u www-data php occ config:app:set dashboard layout --value="<dezelfde lijst zonder introvox-checklist>"
Verificatie¶
Na installatie:
- Log in als reguliere gebruiker die de welkomsttour nog niet had
- De welkomsttour zou vanzelf moeten starten op de eerste pagina die je opent, in je eigen taal, zodra de pagina geladen is
- Check Instellingen → Persoonlijk → IntroVox — de knop Restart tour now zou zichtbaar moeten zijn
Als de wizard niet verschijnt, zie Beheer-troubleshooting.
Zie ook¶
- Beheerdersgids — dagelijks beheer
- Beheer-troubleshooting — wanneer er iets misgaat
- Changelog — wat er per release veranderde (in het Engels)