IntroVox Documentation¶
Welcome to the IntroVox documentation. IntroVox is a Nextcloud app with guided tours: a welcome tour for new users, and short tours that start the first time someone opens an app or a page, such as the built-in tours for Files, Talk, Deck and Calendar. It is built with Vue 3 and Shepherd.js, translates its default steps through Transifex, and has an admin page to write tours, choose who gets them and when, and see how far people get.
The first step of the welcome tour.
Quick Navigation¶
For Users¶
How to take a tour, start one again, and choose whether tours start by themselves.
- Overview — What IntroVox is and how the tour works
- Taking the Tour — Navigating steps, highlighted elements, centered vs. attached
- Personal Settings — Restart, let tours start by themselves or not, start a tour yourself
- Keyboard Navigation — Shortcuts and accessibility features
- Mobile Experience — Responsive layout, touch interactions
- Troubleshooting — Tour not starting, missing steps, language issues
- FAQ — Common user questions
- Tips — Getting the most out of Nextcloud
For Administrators¶
Installation, configuration, step management, and operations.
- Admin Guide — Day-to-day administration
- Settings — Every option on the admin page, the checklist on the Dashboard, and where settings are stored
- Language Management — Override-based per-language customisation (Transifex provides defaults automatically)
- Tours — The welcome tour, built-in tours, tours for an app, a page or anywhere; timing, share links, statistics, AI, export and import
- Managing Tour Steps — Writing steps: text, images and videos, elements, steps that wait for the user, reordering, reset
- Group-Based Visibility — Role-based onboarding with group filters
- Import/Export — The steps of one language as a JSON file
- Best Practices — Content guidelines, language strategy, maintenance
- Troubleshooting — Tour not starting, missing steps, translations
- Telemetry — The optional anonymous usage statistics: what is sent, and how to switch them off
- FAQ — Common admin questions
Features¶
Per-feature documentation for capabilities.
- Guided Tours — How a tour runs: which tour starts, step types, steps that wait, tours across apps
- Multi-Language Support — Transifex integration, auto-detection, per-language steps
- Step Visibility — Group filters + user preferences
- Customization — HTML in step content, CSS selectors, positioning
- Theme Support — Light, dark, high contrast, custom Nextcloud themes
For Architects & Developers¶
Technical documentation for integration, evaluation, and contribution.
- Architecture Overview — System design and components
- API Reference — REST API endpoints
- Frontend Architecture — Vue 3 + Shepherd.js structure
- Backend Architecture — Controllers, services, config storage
- Transifex Integration — Translation workflow
Security¶
- Media in tour steps — Threat model for images and videos in steps
Deployment¶
Installing and upgrading IntroVox.
- Installation — Install from the App Store or source, and upgrade
Getting Started¶
New to IntroVox? Start with the Getting Started Guide for a per-role quickstart.
Support¶
- Issues & Feature Requests: GitHub Issues
- Source Code: GitHub Repository
License¶
IntroVox is licensed under the AGPL-3.0 License.