Get Started#

Smart Classroom runs on Windows 11 and Ubuntu 24.04 LTS. The services, models, and features are the same on both systems. The setup procedure differs, so each operating system has its own guide.

Overview#

On either system, setting up Smart Classroom takes the same four stages:

  1. Check that your machine meets the System Requirements.

  2. Get the application: on Windows, download the installer; on Linux, clone the repository.

  3. Configure features, models, and (optionally) speaker diarization in config.yaml.

  4. Install the prerequisites and start the services: on Windows, from the desktop app; on Linux, with setup.sh, then open the UI at http://localhost:5173.

Choose Your Operating System#

Desktop app installed from SmartClassroom-<version>-setup.exe, available on the Releases page. The app installs the prerequisites, edits the configuration, and runs the services.

  • OS: Windows 11

  • Run with: the Smart Classroom desktop app

Continue with Get Started on Windows.

Docker-based installation driven by the setup.sh script, with the UI served by a Vite dev server.

  • OS: Ubuntu 24.04 LTS

  • Run with: ./setup.sh

Continue with Get Started on Linux.

Common Configuration#

Speaker Diarization (Optional)#

Speaker diarization (identifying who is speaking) is optional and requires a one-time Hugging Face access token. Request access to the Pyannote Speaker Diarization Community v1 model and create a Read token at Hugging Face Access Tokens. For the steps to apply the token, see the guide for your operating system, or the Speaker Diarization Setup.

Network Requirements#

  • Proxy: If you are behind a proxy, configure HTTP_PROXY and HTTPS_PROXY. On Windows, set them on the desktop app’s Configuration screen. On Linux, configure them, and NO_PROXY, for your shell and for Docker.

  • Model downloads: Stable access to huggingface.co is required to download pre-trained models.

Learn More#