Synapse is a study workspace. Organize courses read and annotate the material, train with generated exercises and watch your progress forked from denishovart.com/synapse
synapse docs install.md
4.0 kB · 99 lines
Markdown

Install and configure #

This page explains how to install the app and set it up. You do not need any development tools for anything here. If you want to build the app yourself or host a server, see Development and Install a server.

Get the app #

Builds for macOS, Windows, Linux and Android are on the release page, with a SHA256SUMS.txt to verify them.

On macOS, open the .dmg and drag Synapse into Applications. The build is signed and notarized, so it opens like any other app.

On Windows, run the setup .exe. The installer is not code-signed, so SmartScreen warns on first launch: choose More info, then Run anyway.

On Linux, install the .deb on Debian and Ubuntu, or use the .AppImage anywhere: mark it executable and run it.

On Android, download the .apk and allow installs from your browser when asked. Sideloaded builds do not update themselves: install the newer .apk over the old one, your workspace stays in place.

The store apps for iOS and Android are in a private test; see Download for how to join. The app starts directly on your courses. There is no account to create and nothing else to set up; everything you do is stored on your device.

First steps #

Add a course from the dashboard, add a chapter, then drop a PDF onto the chapter or use Add material. Reading, annotating, exercises and progress all work from there, offline included. The feature tour walks through each page in detail.

Configure #

The sections below all live in Settings, behind the gear in the top bar.

Files beyond PDF #

PDFs work with no setup at all. To add PowerPoint, Word and similar formats, the app relies on converters installed on your machine:

  • LibreOffice handles office documents. Download it from libreoffice.org and install it like any other application.
  • pandoc handles markdown, html, epub and other text formats. See pandoc.org/installing. It also needs a PDF engine such as typst, listed on the same page.

Settings > This device > Document conversion shows which tools Synapse found. Each tool has a path field in case it is installed somewhere unusual. If you skip this section entirely, the rest of the app still works; only non-PDF uploads are refused, with a message explaining why.

AI #

Settings > AI > Your AI provider chooses what generates exercises and transcribes scanned PDFs while no server is connected:

  • Local runtime: install Ollama and run ollama pull llama3.2. Generation then happens entirely on your machine.
  • OpenAI or Anthropic: paste your own API key. The key is stored on this device and used from it directly. See AI setup for how to get a key.

Connecting a server #

If someone hosts a Synapse server for you, connect to it in Settings > Backup & sync > Server with the address and your account. The app then keeps your workspace in sync with the server, and through it with your other devices. A connected server also takes over document conversion and AI, so the two sections above become optional.

Keeping devices in sync #

Two desktop Synapse apps on the same network find each other automatically: open the Sync page from the top bar to see nearby devices and sync with one, or turn on auto-sync to keep them in step in the background. You can also carry a backup file from one device to another. The syncing guide explains the options.

Backup #

Settings > Backup & sync > Backup exports your whole workspace as a single file, including courses, annotations and the documents themselves. Keep it wherever you like. Importing it on any device merges everything back.

Look and language #

Settings > General offers six colour themes and three languages (English, French, Brazilian Portuguese).