Zum Hauptinhalt springen

Sparks for Teams User Manual

Version: 0.1.0
Last Updated: March 2026

Language / Sprache: Deutsch

Table of Contents​

  1. Introduction
  2. Getting Started
  3. Platform-Specific Features
  4. Main Features
  5. Chat & Messaging
  6. Spaces
  7. User Profiles
  8. Presence and status (detailed)
  9. Calendar
  10. Planner & Tasks
  11. Contacts
  12. Teams & Channels
  13. Calls
  14. Settings
  15. Security & Encryption
  16. Accessibility
  17. Keyboard Shortcuts
  18. Troubleshooting

Introduction​

SPARKS is a unified communication and collaboration platform that combines Matrix chat, Microsoft Teams integration, calendar management, task planning, and video calling in one application.

Key Features​

  • Matrix Chat: End-to-end encrypted messaging with Matrix protocol
  • Advanced Search: Powerful search with filters (date, sender, room, file type)
  • Spaces: Organize rooms with hierarchical spaces
  • User Profiles: Status messages and profile management
  • Microsoft Teams Integration: Access Teams chats and channels
  • AI Assistant: AI chat for calendar, contacts, tasks, and chats (Matrix, Microsoft Teams); configurable provider and API key
  • Activity: Unified feed for mentions, messages, calendar, Teams, and connected storage (WebDAV), driven by notification settings
  • Calendar: Microsoft, Sparks Scheduler appointments, Google, Nextcloud (CalDAV), Open-Xchange
  • Contacts: People from Microsoft, Nextcloud (CardDAV), Open-Xchange, Google (when enabled)
  • Planner: Task management (Microsoft Planner, Nextcloud, Open-Xchange, Google when enabled)
  • Video Calls: Integrated video calls and meetings in SPARKS
  • Automatic Encryption: Automatic setup of encryption, cross-signing, and key backup (recovery key policy depends on your organization)
  • Cross-Platform: Available as desktop app (Tauri), mobile app (iOS/Android), and web application

Getting Started​

First Launch​

  1. Launch the Application

    • Desktop: Double-click the SPARKS application icon
    • Web: Navigate to the application URL

    📸 Screenshot: Login Screen

  2. Login Options

    • Matrix Account: Login with your Matrix credentials
    • Microsoft Account: Login with Microsoft/Office 365 account

    📸 Screenshot: Login page showing both login options

    Chat history: In typical setups you sign in with your organization account; the app connects to the Matrix homeserver your operator configured. Existing rooms and message history appear automatically after sync—there is no separate “import chats” step. You need the same Matrix identity as before (same @user:server).

  3. Initial Setup

    • After login, the app will initialize your accounts
    • Encryption is set up automatically in the background (no user interaction needed)
    • For existing users with legacy crypto, migration happens automatically
    • You may see a loading screen during initialization

    📸 Screenshot: Initialization screen

Interface Overview​

The SPARKS interface consists of:

  • Top Toolbar: Window controls, search, notifications, and user menu

  • Sidebar: Navigation between different sections (Chat, Calendar, Teams, etc.)

  • Main Content Area: Displays the active section's content

  • Mobile Bottom Navigation: On mobile devices, quick navigation bar at the bottom

    📸 Screenshot: Main Interface

Platform-Specific Features​

SPARKS is available on multiple platforms, each with platform-specific features and optimizations.

Desktop App (Tauri)​

The desktop app provides native desktop integration and enhanced features.

Installation​

Windows:

  1. Download the .exe installer from the SPARKS website
  2. Run the installer
  3. Follow the installation wizard
  4. Launch SPARKS from the Start menu or desktop shortcut

macOS:

  1. Download the .dmg file from the SPARKS website
  2. Open the .dmg file
  3. Drag SPARKS to your Applications folder
  4. Launch SPARKS from Applications (you may need to allow it in System Settings > Privacy & Security)

Linux:

  1. Download the .AppImage or .deb package
  2. For .deb: Install using sudo dpkg -i sparks.deb
  3. For .AppImage: Make executable (chmod +x sparks.AppImage) and run
  4. Launch SPARKS from your applications menu

Desktop-Specific Features​

  • Native Window Controls: Standard minimize, maximize, and close buttons
  • System Tray Integration: Access SPARKS from the system tray (if enabled)
  • Desktop Notifications: Native OS notifications for messages and calls
  • File System Access: Enhanced file handling with native file dialogs
  • Keyboard Shortcuts: Broad keyboard navigation; customize shortcuts in Settings
  • Deep Linking: Support for custom URL schemes (e.g., sparks://)
  • Auto-Start: Option to launch on system startup

Permissions (Desktop)​

macOS:

  • Microphone: Required for voice calls
  • Camera: Required for video calls
  • Permissions are requested automatically when needed
  • Manage in System Settings > Privacy & Security > Camera/Microphone

Windows:

  • Microphone: Required for voice calls
  • Camera: Required for video calls
  • Permissions are requested automatically when needed
  • Manage in Settings > Privacy > Camera/Microphone

Linux:

  • Permissions depend on your desktop environment

  • Usually handled automatically by the system

    📸 Screenshot: Desktop app interface

Mobile App (iOS/Android)​

The mobile app provides a native mobile experience optimized for touch interaction.

Installation​

iOS:

  1. Open the App Store on your iPhone or iPad
  2. Search for "SPARKS" or "Sparks"
  3. Tap "Get" or "Install"
  4. Wait for installation to complete
  5. Launch SPARKS from your home screen

Android:

  1. Open Google Play Store on your Android device
  2. Search for "SPARKS" or "Sparks"
  3. Tap "Install"
  4. Wait for installation to complete
  5. Launch SPARKS from your app drawer

Mobile-Specific Features​

  • Touch-Optimized Interface: Large touch targets and swipe gestures
  • Mobile Bottom Navigation: Quick access to main features at the bottom
  • Push Notifications: Receive notifications even when app is closed
  • Camera Integration: Direct access to device camera for photos/videos
  • Biometric Authentication: Face ID / Touch ID / Fingerprint support (if enabled)
  • Haptic Feedback: Tactile feedback for interactions
  • VoiceOver (iOS) and TalkBack (Android): Labels and semantics for assistive technologies; larger touch targets where possible
  • Dynamic Type / system font sizes: Respected where the platform and view allow
  • Reduced motion: Where the OS offers “reduce motion”, the app can tone down animations (depends on OS and screen)
  • Safe Area Support: Proper handling of notches and safe areas
  • Offline Mode: Basic functionality available offline

Mobile Interface Differences​

Navigation:

  • Bottom navigation bar instead of sidebar (on mobile)
  • Swipe gestures for navigation
  • Pull-to-refresh for lists

Input:

  • Mobile keyboard optimized for messaging
  • Voice input support
  • Emoji picker optimized for mobile

Media:

  • Direct camera access for photos/videos

  • Native file picker integration

  • Optimized image/video viewing

    📸 Screenshot: Mobile app interface

Permissions (Mobile)​

iOS:

  • Microphone: Required for voice calls
  • Camera: Required for video calls
  • Notifications: For push notifications
  • Photos: For sharing photos (optional)
  • Permissions are requested when needed
  • Manage in iOS Settings > SPARKS

Android:

  • Microphone: Required for voice calls
  • Camera: Required for video calls
  • Storage: For file sharing (optional)
  • Notifications: For push notifications
  • Permissions are requested when needed
  • Manage in Android Settings > Apps > SPARKS > Permissions

Mobile Accessibility​

iOS VoiceOver:

  • Built to work with VoiceOver for core flows
  • ARIA labels and semantic HTML where applicable
  • Touch-optimized targets (minimum 44x44pt where specified by platform guidelines)
  • Dynamic Type support
  • Reduced Motion support where available

Android TalkBack:

  • Built to work with TalkBack for core flows

  • ARIA labels and semantic HTML where applicable

  • Touch-optimized targets

  • Screen reader navigation patterns

    📸 Screenshot: Mobile accessibility features

Web Application​

The web application runs in your browser and works on any platform.

Accessing the Web App​

  1. Open your web browser (Chrome, Firefox, Safari, Edge)
  2. Navigate to the SPARKS web application URL
  3. Bookmark the page for quick access
  4. Optionally, add to home screen (mobile browsers)

Web-Specific Features​

  • No Installation Required: Works immediately in your browser
  • Cross-Platform: Works on any device with a modern browser
  • Browser Extensions: Can work with browser extensions
  • Multiple Tabs: Open multiple SPARKS instances in different tabs
  • Browser Sync: Settings may sync across devices (if browser sync is enabled)

Browser Requirements​

  • Modern Browser: Chrome 90+, Firefox 88+, Safari 14+, Edge 90+
  • HTTPS Required: Must be accessed over HTTPS for encryption
  • JavaScript Enabled: Required for all functionality
  • WebRTC Support: Required for video/audio calls

Web Limitations​

  • No System Tray: No background operation when browser is closed
  • Limited File Access: Browser file picker instead of native dialogs
  • Browser Permissions: Depends on browser permission system
  • Performance: May be slightly slower than native apps

Web accessibility​

  • Keyboard: Use Tab / Shift+Tab to move focus; activate controls with Enter or Space where supported

  • Screen readers: Behavior depends on the browser and its support for ARIA roles, names, and focus management—use an up-to-date browser

  • Zoom: Browser page zoom and OS display scaling apply to the whole UI

    📸 Screenshot: Web application interface

Platform Comparison​

FeatureDesktopMobileWeb
Native Notifications✅✅⚠️ (Browser-dependent)
System Tray✅❌❌
Background Operation✅✅❌
File System Access✅⚠️ (Limited)⚠️ (Limited)
Keyboard Shortcuts✅❌✅
Touch Gestures❌✅⚠️ (Touch devices)
Offline Mode⚠️ (Limited)⚠️ (Limited)❌
Auto-Start✅⚠️ (OS-dependent)❌
Deep Linking✅✅⚠️ (Browser-dependent)

Choosing the Right Platform​

Use Desktop App if:

  • You want native desktop integration
  • You need system tray notifications
  • You want keyboard shortcuts
  • You prefer native file dialogs

Use Mobile App if:

  • You're primarily on mobile devices
  • You need push notifications
  • You want touch-optimized interface
  • You need offline access

Use Web App if:

  • You want no installation
  • You need cross-platform access
  • You're on a shared/public computer
  • You want to test before installing

Accessibility​

SPARKS is designed to work well with keyboard input, common screen readers, and operating-system assistive features. What you experience depends on platform, browser, and sometimes tenant configuration (for example live captions in meetings).

TopicWhere to look in SPARKS
Readability & contrastSettings → Appearance: font size, density, light/dark theme (including “System”)
Keyboard & shortcutsSettings → Keyboard Shortcuts; global search/command palette with Ctrl+K / Cmd+K
Focus & interruptionsSettings → Notifications and Privacy (Do Not Disturb); meetings: push-to-talk / unmute shortcut (see Privacy)
MeetingsWhen offered: live captions, transcripts in call history—see Calls and your admin’s meeting options
MobileVoiceOver / TalkBack—see Mobile App (iOS/Android) under Platform-Specific Features

Limits: In embedded tabs, custom tabs, and Microsoft Teams apps (web content inside an iframe), accessibility is governed by the third-party site. SPARKS cannot fully control that experience.

If you hit a barrier, contact your support or IT team—concrete reports help prioritize improvements.

Main Features​

The sidebar provides access to all main features:

  1. Chat - Matrix chat rooms and conversations
  2. Teams - Microsoft Teams integration
  3. Calendar - Calendar (Microsoft, Sparks Scheduler, Google, Nextcloud, Open-Xchange)
  4. Planner - Task management (Microsoft Planner, Nextcloud, Open-Xchange, Google when enabled)
  5. Calls - Voice and video calls, contacts/phone book, speed dial
  6. Contacts - People from Microsoft, Nextcloud, Open-Xchange, Google when enabled
  7. Activity - Notifications and activity feed
  8. AI Assistant - AI chat for calendar, tasks, and meeting preparation
  9. Microsoft Teams Chat - Direct Teams chat messages
  10. Microsoft Teams Channels - Teams channel conversations

📸 Screenshot: Sidebar with all navigation items

The sidebar shows these apps (order may vary):

AppPathDescription
Chat/Matrix chat rooms
Teams/teamsMicrosoft Teams integration
Calendar/calendarCalendar (Microsoft, Sparks Scheduler, Google, Nextcloud, OX)
Planner/plannerTasks (Microsoft Planner, Nextcloud, OX, Google when enabled)
Calls/callsVoice/video calls, phone book, speed dial
People/contactsContacts from connected providers
Activity/activityNotifications and activity feed
AI Assistant/assistantAI chat for calendar, contacts, tasks, chats
Microsoft Teams Chat/ms-chatDirect Teams messages
Microsoft Teams Channels/ms-channelsTeams channel conversations

Customizing Sidebar​

  • Reorder Apps: Drag and drop apps in the sidebar to reorder them

  • Show/Hide Apps: Right-click on an app to hide or show it

  • Add Apps: Click the "+" button to add apps from the catalog (Microsoft Teams apps or custom URLs)

  • Settings → Appearance: Option "Separate Matrix and Microsoft" groups Matrix and Microsoft apps separately

    📸 Screenshot: Sidebar customization dialog

Chat & Messaging​

Matrix Chat​

Viewing Rooms​

  • All your Matrix rooms appear in the chat list

  • Click on a room to open it

  • Unread messages are indicated with a badge

    📸 Screenshot: Chat List

Sending Messages​

  1. Select a room from the chat list

  2. Type your message in the message input at the bottom

  3. Press Enter to send

  4. Use Shift+Enter for a new line

    📸 Screenshot: Message input area

Message Features​

  • Emoji Reactions: Click the emoji button or hover over a message to add reactions

  • Reply: Right-click a message and select "Reply"

  • Edit: Right-click your own message and select "Edit"

  • Delete: Right-click your own message and select "Delete"

  • Forward: Right-click a message and select "Forward"

  • Pin Messages: Click the pin icon to pin important messages

    📸 Screenshot: Message context menu

Creating Rooms​

  1. Click the "+" button in the chat list

  2. Enter a room name

  3. Choose room settings (public/private, encryption)

  4. Click "Create"

    📸 Screenshot: Create room dialog

Room Settings​

  • Click the room name or settings icon to access room settings

  • Configure room name, topic, avatar

  • Manage members and permissions

  • View room encryption status

    📸 Screenshot: Room settings drawer

Chat and Channel Tabs​

Chat rooms and channels can have tabs – additional panels alongside the conversation.

Adding a tab:

  1. Open a chat room or channel
  2. Click the "+" button in the tab bar (or "Add Tab")
  3. Choose from Integrated Tabs or Custom Tabs

Integrated tabs:

  • Polls (Survey): Create and participate in polls within the chat or channel
  • Whiteboard: Collaborative drawing with Excalidraw. Sketch, draw shapes, add text, and collaborate in real time. All participants see the same canvas. For Excalidraw features and usage, see the official Excalidraw documentation.

Custom tabs:

  • Add external web apps by URL (e.g. shared documents, dashboards)
  • Enter a valid HTTP/HTTPS URL
  • The tab loads in an iframe; some sites may block embedding

Managing tabs: Right-click a tab to remove it or open in a new window.

Session memory: Which tab was last active (conversation, shared view, polls, files, widget tabs, …) is remembered per room or channel for the current browser session. When you open the same room or channel again, that tab is selected; the default is the main conversation or posts view. A new browser tab or another browser does not share this memory.

📸 Screenshot: Add Tab dialog with integrated tabs (Polls, Whiteboard) 📸 Screenshot: Whiteboard tab (Excalidraw)

Microsoft Teams Chat​

Access Microsoft Teams direct messages (1:1 chats) via Microsoft Graph:

  1. Navigate to "Microsoft Teams Chat" in the sidebar
  2. View your Teams conversations in the chat list (left)
  3. Select a chat to view and send messages
  4. Search for chats using the search field

Features:

  • Send messages: Rich text, emojis, mentions (@)
  • Edit/Delete: Edit or delete your own messages
  • Reactions: Add emoji reactions to messages
  • Read receipts: See when messages have been read
  • Forward: Forward messages to other chats
  • Pin/Mute: Pin important chats, mute notifications
  • Chat settings: Configure notification behavior per chat

Requirements: Microsoft/Office 365 account must be connected.

📸 Screenshot: Microsoft Teams chat interface

Microsoft Teams Channels​

Access Microsoft Teams channels (team conversations) via Microsoft Graph:

  1. Navigate to "Microsoft Teams Channels" in the sidebar
  2. Select a team from the list (left)
  3. Select a channel within that team
  4. View and participate in channel conversations

Features:

  • Posts: Create new posts, reply to existing ones
  • Threads: Reply in threads to keep conversations organized
  • Reactions: Add emoji reactions to messages
  • Edit/Delete: Edit or delete your own messages
  • Pin messages: Pin important messages in the channel
  • @Mentions: Mention team members with @
  • Files: View and upload files in the channel
  • Create team/channel: Create new teams and channels (if you have permissions)
  • Manage: Edit team/channel settings, manage members

Requirements: Microsoft/Office 365 account must be connected.

📸 Screenshot: Teams channels interface

SPARKS includes powerful search capabilities with advanced filtering options.

  1. Click the search icon in the top toolbar (or press Ctrl+K / Cmd+K)

  2. Select "Advanced Search" from the search menu

  3. The advanced search dialog will open

    📸 Screenshot: Advanced Search dialog

Search Filters​

You can filter your search results using:

  • Date Range: Search for messages within a specific time period
    • Select "From Date" to set the start date
    • Select "To Date" to set the end date
  • Sender: Filter messages by a specific user
    • Select a user from the sender dropdown
  • Room: Search within a specific room
    • Select a room from the room dropdown
  • File Type: Filter by file type
    • Images: Photos and graphics
    • Documents: PDFs, Word docs, etc.
    • Videos: Video files
    • Audio: Audio files
  1. Enter your search query in the search box
  2. (Optional) Apply filters to narrow down results
  3. Click "Search" or press Enter
  4. Results will appear below with message previews
  5. Click on a result to navigate to that message in the room

Search Tips​

  • Use multiple filters together for precise searches

  • Click "Reset Filters" to clear all filters

  • Search results show message context and metadata

  • Matrix search API provides full-text search within rooms

    📸 Screenshot: Search results with filters applied

Spaces​

Spaces help you organize your Matrix rooms into hierarchical groups, making it easier to manage large numbers of rooms and conversations.

What are Spaces?​

Spaces are containers that can hold:

  • Rooms: Chat rooms and conversations
  • Other Spaces: Nested spaces for complex organization
  • Both: Mix of rooms and sub-spaces

Viewing Spaces​

  1. Navigate to the Spaces view (may be integrated into sidebar or Chat section)

  2. You'll see a tree view of all your spaces

  3. Click on a space to expand it and see its contents

  4. Click on a room within a space to open it

    📸 Screenshot: Space hierarchy tree view

Space Hierarchy​

Spaces can be nested to create organizational hierarchies:

  • Parent Spaces: Top-level spaces
  • Child Spaces: Spaces within other spaces
  • Rooms: Individual chat rooms within spaces

The space tree shows:

  • Space names and descriptions
  • Member counts
  • Unread message indicators
  • Expandable/collapsible nodes

Creating Spaces​

  1. Click the "+" button in the Spaces view

  2. Enter a space name

  3. (Optional) Add a description

  4. Click "Create"

  5. The new space will appear in your space tree

    📸 Screenshot: Create space dialog

Adding Rooms to Spaces​

  1. Right-click on a room in your chat list
  2. Select "Add to Space"
  3. Choose the space where you want to add the room
  4. The room will now appear under that space in the hierarchy

Space Settings​

To manage a space:

  1. Right-click on a space in the tree view

  2. Select "Space Settings"

  3. Configure:

    • Name: Change the space name
    • Description: Add or edit the description
    • Members: View space members

  4. Click "Save" to apply changes

    📸 Screenshot: Space settings dialog

Organizing with Spaces​

Use spaces to organize:

  • Projects: Group rooms by project
  • Teams: Organize by team or department
  • Topics: Group related conversations
  • Clients: Separate client communications

Space Features​

  • Pinning: Pin important spaces for quick access

  • Unread Counts: See unread messages at a glance

  • Member Counts: View how many people are in each space

  • Nested Organization: Create complex hierarchies for large organizations

    📸 Screenshot: Space with nested rooms and sub-spaces

User Profiles​

SPARKS allows you to view and manage user profiles, including your own profile and profiles of other users.

Viewing Your Profile​

  1. Click on your avatar in the top toolbar

  2. Select "Profile" from the menu

  3. Your profile dialog will open showing:

    • Display name
    • Avatar
    • Status message
    • Devices
    • Security settings link

    📸 Screenshot: Your profile view

Viewing Other Users' Profiles​

  1. Click on a user's avatar in a chat room

  2. Or click on a user's name in the member list

  3. The user's profile will open showing:

    • Display name
    • Avatar
    • Status message
    • Presence status (online, away, busy, offline)
    • Last seen time

    📸 Screenshot: Other user's profile view

Editing Your Profile​

  1. Open your profile (see "Viewing Your Profile" above)

  2. Click "Edit" or "Edit Profile"

  3. Update:

    • Display Name: Your name as others see it
    • Avatar URL: MXC URL (mxc://...) or HTTP URL for your avatar
    • Status Message: A short message about your current status

  4. Click "Save" to apply changes

    📸 Screenshot: Profile editor dialog

Status Messages​

Status messages let you share what you're currently doing:

  • Examples: "Working from home", "In a meeting", "Available"
  • Status messages are visible to other users
  • You can update your status message anytime
  • Status messages are stored in your account data

Device Management​

View and manage your devices:

  1. Open your profile

  2. Click on "Devices" or "Device Management"

  3. You'll see a list of all devices where you're logged in:

    • Device ID
    • Device name (if set)
    • Last seen time

  4. You can delete devices you no longer use:

    • Click "Delete" next to a device
    • Confirm the deletion

    📸 Screenshot: Device list dialog

Note: Deleting a device will log you out from that device. Make sure you have access to your encryption keys before deleting devices.

Profile Features​

  • Presence Indicators: See when users are online, away, busy, or offline
  • Last Seen: View when a user was last active
  • Security Settings: Quick link to security and encryption settings
  • Device List: Manage all your logged-in devices

Calendar​

The Calendar displays events from your connected providers (Microsoft Outlook, Nextcloud CalDAV, Open-Xchange). Events from different providers may show provider badges to identify their source.

Viewing Calendar​

  1. Click "Calendar" in the sidebar

  2. Choose your view:

    • Day View: See events for a specific day
    • Week View: See events for the week
    • Month View: See events for the month
    • Agenda View: List view of upcoming events

  3. Use the date navigator to move between days/weeks/months

  4. Events from multiple providers are shown together; provider badges indicate the source

    📸 Screenshot: Calendar Month View

Creating Events​

  1. Click the "+" button or double-click on a time slot

  2. Fill in event details:

    • Title: Event name
    • Date and time: Start and end
    • Location: Physical or virtual location
    • Attendees: Add participants (email addresses)
    • Description: Optional notes

  3. Choose if it's an online meeting (creates a meeting link)

  4. Sparks meeting options (when Sparks online meeting is on): access, lobby, chat/polls/Q&A, recording, captions, meeting language, transcript (some features depend on your organization’s plan). Access rules are also enforced on the server when issuing the join token, if the appointment is stored on the same Vista node. See Event and meeting options.

  5. Recurring events: Set recurrence (daily, weekly, monthly, etc.)

  6. Select the provider/calendar where the event should be saved (if multiple are connected)

  7. Click "Save"

    📸 Screenshot: New event dialog

Editing Events​

  • Click on an event to view details

  • Click "Edit" to modify the event

  • Make changes and click "Save"

  • Delete: Remove the event from your calendar

    📸 Screenshot: Event details view

Meeting Chat (Sparks / Scheduler meetings)​

For events that have a Sparks meeting (Scheduler appointment), you can open the meeting chat – a Matrix room used for chat, Q&A, and polls before, during, and after the meeting.

From the calendar:

  1. Right-click an event that has a Sparks meeting (e.g. "Join Sparks Meeting" is shown in the context menu)
  2. Click "Open meeting chat" (or "Meeting-Chat öffnen" in German)
  3. If the meeting does not yet have a chat room, one is created automatically and you are taken to the chat view
  4. If the meeting already has a chat room, that room opens in the chat list

In the meeting: If you open the Chat tab in the meeting toolbar and the meeting has no chat room yet, a Matrix room is created on first use and the chat opens. You can then use Chat, Q&A, and Polls in that room.

This "create on first access" behaviour means a chat room is only created when someone actually uses it (from the calendar or in the meeting).

📸 Screenshot: Calendar context menu with "Open meeting chat" 📸 Screenshot: Meeting toolbar with Chat tab (optional: first-time open)

Scheduling Assistant​

When creating or editing events with attendees:

  1. Click "Scheduling Assistant"

  2. View attendee availability (free/busy)

  3. Find the best time slot for all attendees

  4. Select a time and save

    📸 Screenshot: Scheduling assistant view

Multiple Providers​

  • Connect multiple calendar backends (Microsoft, Nextcloud, OX) in Settings → Provider Accounts
  • Events from all connected calendars are displayed in a unified view
  • Create events in the calendar of your choice when creating/editing

Planner & Tasks​

The Planner displays tasks from your connected providers (Microsoft Planner, Nextcloud Tasks, Open-Xchange Tasks). Tasks are organized by plans and buckets; provider badges indicate the source.

Viewing Tasks​

  1. Click "Planner" in the sidebar

  2. Choose your view:

    • Board View: Kanban-style board with buckets (columns)
    • List View: Simple list of tasks
    • Schedule View: Timeline view by due date
    • Charts View: Progress charts and statistics

  3. Select a plan from the dropdown (if you have multiple plans)

  4. Tasks from multiple providers may be shown; provider badges identify the source

    📸 Screenshot: Planner Board View

Creating Tasks​

  1. Click "+ Add task" or the "+" button

  2. Enter task details:

    • Title: Required
    • Due date: Optional
    • Assignees: Add team members
    • Bucket/Plan: Choose bucket and plan
    • Description: Notes and checklist items
    • Priority: Low, medium, high

  3. Select the provider where the task should be created (if multiple are connected)

  4. Click "Create"

    📸 Screenshot: Create task dialog

Managing Tasks​

  • Move Tasks: Drag and drop tasks between buckets

  • Edit Tasks: Click on a task to edit details

  • Complete Tasks: Check the checkbox or set progress to 100%

  • Assign Tasks: Add team members as assignees

  • Add to My Day: Click the star icon to add to "My Day"

  • Delete: Remove a task (if supported by provider)

    📸 Screenshot: Task card with actions

Task Filters​

Filter tasks by:

  • All: Show all tasks

  • My Tasks: Show only tasks assigned to you

  • In Progress: Show tasks in progress

  • Completed: Show completed tasks

    📸 Screenshot: Filter options

Multiple Providers​

  • Connect multiple task backends (Microsoft Planner, Nextcloud, OX) in Settings → Provider Accounts
  • Tasks from all connected providers are displayed in a unified view
  • Create tasks in the provider of your choice when creating

Contacts​

The Contacts (People) page shows contacts from your connected providers (Microsoft Outlook, Nextcloud CardDAV, Open-Xchange). Contacts from all providers are shown in a unified list.

Viewing Contacts​

  1. Click "Contacts" or "People" in the sidebar
  2. Browse All Contacts, Favorites, or Categories (if your provider supports categories)
  3. Use the search field to find contacts by name or email
  4. Click a contact to open the detail view and access actions

Layout:

  • List view: Contact list on the left, details on the right

  • Contact card: Shows name, photo, email, phone, job title, department

    📸 Screenshot: Contacts page

Managing Contacts​

  • Add contact: Create new contacts in your provider (if supported)
  • Edit contact: Update contact details from the provider
  • Delete contact: Remove a contact (if supported by provider)
  • Add to Speed Dial: From the Calls page or contact context menu
  • Remove from Speed Dial: Use the context menu in the speed dial list
  • Copy to Microsoft: Save a contact to your Outlook account (requires Contacts.ReadWrite permission)

Contact actions (Chat, Call, Video call) are available from the contact card or context menu.

Multiple Providers​

  • Connect multiple address books (Microsoft, Nextcloud, OX) in Settings → Provider Accounts

  • Contacts from all providers are shown in a unified list

  • Provider badges may indicate the source of each contact

    📸 Screenshot: Contacts page

Teams & Channels​

Viewing Teams​

  1. Click "Teams" in the sidebar

  2. Browse your Microsoft Teams

  3. Click on a team to view its channels

    📸 Screenshot: Teams List

Viewing Channels​

  1. Select a team

  2. View all channels in that team

  3. Click on a channel to view messages

    📸 Screenshot: Channels list

Channel Features​

  • Send Messages: Type and send messages in channels

  • Reply to Messages: Click "Reply" on a message

  • React to Messages: Click the emoji button

  • View Files: Access shared files in the channel

  • Upload Files: Drag and drop or click to upload files

    📸 Screenshot: Channel conversation view

Calls​

Making Calls​

  1. Click "Calls" in the sidebar

  2. Use the phone book to find contacts

  3. Click the call button next to a contact

  4. Choose call type:

    • Audio Call: Voice only
    • Video Call: Video and audio

    📸 Screenshot: Calls Page

Receiving Calls​

  • When someone calls you, a call dialog appears

  • Click "Accept" to answer or "Decline" to reject

  • For video calls, allow camera and microphone access when prompted

    📸 Screenshot: Incoming call dialog

During a Call​

  • Mute/Unmute: Click the microphone button

  • Video On/Off: Click the camera button

  • Screen Share: Click the screen share button

  • End Call: Click the red end call button

  • Participants: View and manage participants

    📸 Screenshot: Active call interface

Call Log (Call History)​

View your past calls (incoming, outgoing, missed, voicemail):

  1. Click "Calls" in the sidebar
  2. Switch to the Call Log / History tab
  3. Browse your call history sorted by date

Features:

  • Call types: Incoming, outgoing, missed, voicemail (with different icons)
  • Details: Timestamp, duration, participant name
  • Search: Search your call history
  • Call back: Click a contact to initiate a new call
  • Add to Speed Dial: Add frequent contacts to speed dial
  • Transcripts: For eligible calls, view stored transcripts (full text and/or AI summary and action items, depending on backend). Live captions during a call are separate from the persisted transcript in this list.

Requirements: Usually OIDC authentication with telephony/Conf backend; self-hosted setups may use the Vista node call log with Matrix identity—see Data backends.

📸 Screenshot: Call log / call history

Meeting Rooms​

Join meeting rooms for group calls and video conferences.

Joining a Meeting​

  1. Click "Calls" in the sidebar

  2. Click "Join Meeting" or enter a Meeting ID

  3. (Optional) Enter a passcode if required

  4. Click "Join"

  5. On the Pre-Join page: Check your camera and microphone, optionally enable background blur

  6. Click "Join Meeting" to enter

  7. Allow camera and microphone access when prompted

    📸 Screenshot: Join meeting dialog

Pre-Join Page: Before entering, you can test your camera and microphone, toggle video/audio on or off, and configure background effects. This helps ensure everything works before joining.

Meeting Controls​

During a meeting, you have access to various controls:

  • Camera: Toggle your video on/off

  • Microphone: Mute/unmute your audio

  • Screen Share: Share your screen with participants

  • Participants: View the participants list

  • React: Send reactions (emojis) during the meeting

  • View Mode: Switch between different video layouts

  • More Options: Access additional meeting settings

  • Leave Meeting: Exit the meeting

    📸 Screenshot: Meeting controls toolbar

Meeting Toolbar (Center Section)​

Additional controls in the meeting toolbar:

  • Chat: Open in-meeting chat to send messages. If the meeting is not yet linked to a Matrix room, the room is created when you open the Chat tab for the first time ("create on first access").
  • Q&A: Questions and answers – ask questions and view answers from moderators
  • Polls: Create and participate in polls (moderators can create; participants can vote)
  • Participants: Show/hide the participants list
  • Breakout Rooms: Organizers/moderators can create and manage breakout rooms
  • Raise Hand: Raise or lower your hand to get attention
  • React: Send emoji reactions (thumbs up, heart, laugh, etc.) visible to all
  • View: Switch between Gallery (grid) and Speaker view
  • Whiteboard: Open a collaborative whiteboard (Excalidraw) for drawing and notes
  • Background Effects: Blur your background or use a custom image (from Video/More menu)

Moderator-Only Features​

If you are the meeting organizer or moderator:

  • Add participants: In the participants (people) panel, invite others via copy link, email, Microsoft Teams chat, or Matrix room invite when the meeting is linked to a Matrix room. Phone invite may be hidden depending on your organization.
  • Breakout Rooms: Create rooms, assign participants, open/close rooms
  • Controls Menu: Recording (requires server setup), Meeting timer
  • Participant Actions: Pin, spotlight, or remove participants

Participant Management​

  • View Participants: Click "Show participants" to see all attendees

  • Pin Video: Pin a participant's video to focus on them

  • Unpin Video: Remove pinning to return to grid view

  • Spotlight: Moderators can spotlight a participant for everyone

  • Speaker Stats: View speaking time statistics (who spoke how long)

  • Close Participants List: Hide the participants panel

    📸 Screenshot: Participants list

Meeting Features​

  • Raise Hand: Raise your hand to get attention
  • Video Layouts: Gallery (grid of all participants) or Speaker (large active speaker)
  • Whiteboard: Collaborative drawing with Excalidraw – all participants see the same canvas
  • Chat, Q&A, Polls: Available when the meeting is linked to a Matrix room (the room is created on first use if not yet linked)
  • Background Effects: Blur or custom background (via Video button → Background effects)
  • Device Selection: Change camera, microphone, or speaker in the More menu
  • Recording: Requires server-side recording export to be configured – moderators see the option when available
  • End-to-End Encryption: For 1:1 calls, E2EE can be enabled in Privacy settings. For meetings, E2EE depends on the meeting setup (when available, a shield icon indicates encrypted connection).

Screen Sharing​

  1. Click the "Share screen" button
  2. Choose what to share:
    • Entire screen
    • Specific application window
    • Browser tab (web version)
  3. Click "Share"
  4. Others will see your shared content
  5. Click "Stop sharing" to end screen share

Meeting Tips​

  • Test your camera and microphone before joining
  • Use a stable internet connection for best quality
  • Mute yourself when not speaking to reduce background noise
  • Pin important participants for better focus
  • Use screen sharing for presentations and collaboration
  • Use the whiteboard for brainstorming and visual notes
  • Background blur can improve video quality in busy environments

When Leaving: You may be asked to complete a short feedback survey. This helps improve the meeting experience.

📸 Screenshot: Meeting room interface with controls

Settings​

Access settings by clicking the Settings icon in the sidebar or your profile menu.

General Settings​

  • Language: Choose application language

    • Currently supported: English, German
    • More languages may be available as translations are completed
    • Language changes apply immediately

  • Date Format: US (MM/DD/YYYY) or European (DD/MM/YYYY) format

  • Time Format: 12-hour (AM/PM) or 24-hour format

  • First Day of Week: Monday or Sunday

  • Number Format: US or European number formatting

    📸 Screenshot: General Settings

Appearance​

  • Theme: Light, Dark, or System

  • Brand Color: Choose accent color

  • Font Size: Adjust text size

  • Density: Compact, Normal, or Comfortable

    📸 Screenshot: Appearance Settings

Chat Settings​

  • Message Formatting: Rich text or plain text

  • Emoji Skin Tone: Default skin tone for emojis

  • Read Receipts: Enable/disable read indicators

  • Typing Indicators: Show when others are typing

  • Separate Matrix and Microsoft: Show Matrix and Microsoft apps separately in sidebar

    📸 Screenshot: Chat settings

Notifications​

  • Desktop Notifications: Enable/disable desktop notifications

  • Sound Notifications: Enable/disable sound alerts

  • Notification Settings: Configure what triggers notifications

    📸 Screenshot: Notification settings

Privacy​

  • Do Not Disturb: Manage who can reach you when status is "Do Not Disturb"

  • Priority Contacts: Click "Manage Priority Contacts" to open the list; priority contacts get notifications even when you are in Do Not Disturb

  • Blocked Contacts: Click "Manage Blocked Contacts" to block or unblock contacts; blocked contacts cannot call you, message you, or see your presence

  • Surveys, Diagnostic Data, E2EE Calls, Optional Connected Experiences: See Privacy Help for details

    📸 Screenshot: Privacy settings

Security​

  • Encryption Status: View encryption setup status

  • Device Management: View and manage your devices (also accessible from User Profile)

  • Key Backup: Set up and manage encryption key backup

  • Cross-Signing: View cross-signing status

  • User Profile: Quick access to profile and device management

    📸 Screenshot: Security Settings

Keyboard Shortcuts​

  • View all available keyboard shortcuts

  • Customize shortcuts to your preference

  • Learn productivity shortcuts

    📸 Screenshot: Keyboard shortcuts dialog

Provider Accounts & Organisations​

  • Calendar: Connect Microsoft, Nextcloud (CalDAV), or Open-Xchange for calendar data

  • Contacts: Connect Microsoft, Nextcloud (CardDAV), or Open-Xchange for contacts

  • Tasks: Connect Microsoft Planner, Nextcloud, or Open-Xchange for tasks

  • Storage: Connect Microsoft OneDrive or WebDAV for file storage

  • Default Provider: Set which provider is used by default when multiple are connected

  • Use "Connect" to add new provider accounts (e.g. Nextcloud, OX)

    📸 Screenshot: Provider accounts settings

Account Settings​

  • Microsoft Account: View and manage Microsoft account

  • Matrix Account: View Matrix account information

  • Logout: Sign out of your accounts

    📸 Screenshot: Account settings

Security & Encryption​

Encryption Overview​

SPARKS uses Matrix's end-to-end encryption (Rust Crypto) to secure your messages. Encryption is set up automatically for all users, ensuring your messages are protected from the start. The recovery key is stored securely on the server so you don't need to manage it yourself.

Automatic Encryption Setup (First Device)​

When you first log in, encryption is configured automatically in the background:

  1. Secret Storage: Your encryption keys are stored securely
  2. Cross-Signing: Your devices are automatically cross-signed for security
  3. Key Backup: Your keys are automatically backed up
  4. Recovery Key: Stored securely on the server (AES-256-GCM encrypted)

No user interaction required - everything happens automatically!

Logging In on a Second Device​

When you sign in on an additional device (another browser, desktop app, or Tauri):

  1. Your recovery key is automatically fetched from the server
  2. Secret Storage is opened with the existing key
  3. Your encryption keys are restored from backup
  4. The new device is automatically verified via cross-signing
  5. All your older messages are readable immediately

No manual action needed - your messages are available on the new device right away.

When Manual Action is Needed​

You may need to set up encryption manually if:

  • Your organization uses "strict" device verification policy
  • The automatic server fetch fails (rare)
  • You want to manually verify a specific device

Manual Encryption Setup​

If automatic setup didn't complete, you can set it up manually:

  1. Go to Settings → Security

  2. Click "Set Up Encryption" or "Open Setup Wizard"

  3. Follow the encryption setup wizard:

    • Set up secret storage
    • Create recovery key (displayed in Element-compatible format)
    • Set up cross-signing
    • Enable key backup

    📸 Screenshot: Encryption setup wizard

Recovery Key​

Your recovery key is a backup key that allows you to restore your encryption on a new device.

Default behavior: The recovery key is stored securely on the SPARKS server. You don't need to save it yourself. Optionally, you can note it down as an additional backup.

Strict mode (if enabled by your admin): The recovery key is NOT stored on the server. You must save it yourself when it's displayed during setup. The wizard will require you to confirm that you saved it before proceeding.

The recovery key is in Element-compatible format (starts with "EsSS...") and can be entered in Element or any Matrix client.

You can view your recovery key at any time:

  1. Go to Settings → Security → Key Backup
  2. Click "View Recovery Key"
  3. Copy and save it securely

Device Verification​

By default, new devices are verified automatically when you log in. If manual verification is needed:

  1. Go to Settings → Security → Device Management
  2. View all your devices
  3. Verify new devices using:
    • SAS Verification: Compare emoji or numbers with another device
    • QR Code: Scan QR code with another device

Verifying Other Users​

When chatting with someone for the first time:

  1. You may see a verification request
  2. Choose verification method (SAS or QR code)
  3. Compare codes or scan QR code
  4. Click "Verify" if codes match

Key Backup​

Automatic Backup​

Key backup is set up automatically during encryption setup. Your room keys are continuously backed up so they can be restored on new devices.

Manual Backup Restoration​

If automatic restoration didn't work:

  1. Go to Settings → Security → Key Backup
  2. Click "Restore Backup"
  3. Enter your recovery key
  4. Wait for restoration to complete

Organization Security Policies​

Your organization administrator may configure security policies that affect encryption behavior:

PolicyEffect
Comfortable (default)Recovery key stored on server, automatic device setup
StrictNo server-side key storage, manual verification required for each device

These settings are managed in the SPARKS Account Admin portal and apply to all members of your organization.

Keyboard Shortcuts​

  • Ctrl+K (Cmd+K on Mac): Open command palette / search

  • Ctrl+Period (Cmd+Period on Mac): Open settings

  • Escape: Close dialogs, cancel actions

    📸 Screenshot: Keyboard shortcuts reference

Chat Shortcuts​

  • Ctrl+Shift+M (Cmd+Shift+M on Mac): Focus message input
  • Ctrl+Up/Down: Navigate between rooms
  • Ctrl+F: Search in current room

General Shortcuts​

  • Ctrl+, (Cmd+, on Mac): Open settings
  • Ctrl+/: Show keyboard shortcuts help

Customizing Shortcuts​

  1. Go to Settings → Keyboard Shortcuts

  2. Click on a shortcut to customize

  3. Press your desired key combination

  4. Click "Save"

    📸 Screenshot: Customize shortcuts dialog

Troubleshooting​

Login Issues​

Problem: Cannot log in with Microsoft account

Solutions:

  1. Check your internet connection

  2. Verify your Microsoft account credentials

  3. Clear browser cache and cookies (web version)

  4. Check if pop-ups are blocked

  5. Desktop App (Tauri): Ensure redirect URI is configured in Azure AD

  6. Mobile App: Check if browser pop-ups are allowed in app settings

  7. Web App: Try a different browser or incognito mode

    📸 Screenshot: Login error message

Encryption Issues​

Problem: Encryption not working

Solutions:

  1. Check if automatic setup completed:

    • Go to Settings → Security
    • Look for encryption status indicators

  2. If automatic setup failed:

    • Go to Settings → Security → Encryption Validation
    • Run validation tests
    • Check error messages for specific issues

  3. For migration issues:

    • Wait for migration to complete (may take time for large accounts)
    • Check for migration progress indicators
    • Don't interrupt the migration process

  4. General troubleshooting:

    • Ensure you're using HTTPS (web) or secure context
    • Try refreshing the page/app
    • Check browser/app permissions
    • Try clearing encryption data and re-setting up (last resort)

    📸 Screenshot: Encryption validation results

Search Not Working​

Problem: Advanced search not finding messages

Solutions:

  1. Check if you're searching in the correct room (if room filter is applied)
  2. Try removing filters to broaden the search
  3. Verify your search query is spelled correctly
  4. Check if the room is encrypted - search in encrypted rooms requires key backup
  5. Try refreshing and searching again

Profile Update Issues​

Problem: Cannot update profile or status message

Solutions:

  1. Check your internet connection
  2. Verify you're logged in
  3. Try refreshing the page/app
  4. Check if profile changes are saved (may take a moment)
  5. For avatar URLs, ensure you're using a valid MXC URL (mxc://...) or HTTP URL

Messages Not Sending​

Solutions:

  1. Check your internet connection
  2. Verify you're logged in
  3. Check if the room is encrypted and encryption is set up
  4. Try refreshing the page/app
  5. Check console for error messages (F12)

Calendar Not Syncing​

Solutions:

  1. Verify Microsoft account is connected
  2. Check calendar permissions in Microsoft account
  3. Refresh the calendar view
  4. Re-authenticate Microsoft account

Calls Not Working​

Solutions:

  1. Allow Permissions:
    • Desktop: Check system settings (macOS: System Settings > Privacy & Security; Windows: Settings > Privacy)
    • Mobile: Check app permissions in device settings
    • Web: Check browser permissions (click lock icon in address bar)
  2. Check your internet connection
  3. Verify audio/video devices are working
  4. Desktop: Restart the app if permissions were just granted
  5. Mobile: Force close and reopen the app
  6. Web: Refresh the page
  7. Try a different device to isolate the issue

"Copy to Microsoft failed" (Tab Kontakte / Bereich Personen)​

Problem: When you use Copy to Microsoft in the phone book (to save a contact to your Microsoft/Outlook account), a dialog appears: "Copy to Microsoft failed" (or "Kopieren zu Microsoft fehlgeschlagen").

What this means: The contact could not be saved to your Microsoft account because the app does not yet have permission to create or change contacts there. Microsoft is refusing the request (you may see technical messages like "not allowed" or "403").

What you can do:

  1. Sign out of Microsoft in the app (via your profile or account settings).
  2. Sign in again with your Microsoft account.
  3. When Microsoft asks for permissions, allow the app to "Read and write your contacts" (Contacts.ReadWrite).

Work or school accounts: If you use a Microsoft work or school account, your IT administrator may need to approve this permission for the app first. In that case, contact your administrator or try again later.

Other errors: If the message is different (e.g. network error or "service unavailable"), try again later, check your internet connection, or sign out of Microsoft and sign in again.

Performance Issues​

Solutions:

  1. Close unused rooms/conversations
  2. Clear Cache:
    • Desktop: Clear app data in settings or reinstall
    • Mobile: Clear app cache in device settings
    • Web: Clear browser cache and cookies
  3. Restart the application
  4. Check available system resources (RAM, storage)
  5. Disable unnecessary features in settings
  6. Desktop: Check for app updates
  7. Mobile: Ensure sufficient storage space
  8. Web: Try a different browser or disable extensions

End of User Manual

For the latest updates and additional documentation, check the application's documentation files.