01 - Quick Start Guide
01 - Quick Start Guide
Section titled “01 - Quick Start Guide”⏱️ Time Estimate: 10-15 minutes
📋 What You’ll Learn: How to install Selfoss, activate your license, choose your privacy mode, create your first project, and process your first transcript
Table of Contents
Section titled “Table of Contents”- Installation & Launch
- License Activation
- Choosing Your Privacy Mode
- First Project Setup
- Your First Transcript
- Troubleshooting
- Next Steps
Installation & Launch
Section titled “Installation & Launch”Windows
Section titled “Windows”- Download the latest
.exeinstaller from the Selfoss releases page - Run the installer and follow the on-screen instructions
- Launch Selfoss from the Start Menu or Desktop shortcut
- ✅ The app will open with the Welcome Screen
- Download the latest
.dmgfile from the Selfoss releases page - Open the
.dmgfile and drag Selfoss to your Applications folder - Launch Selfoss from Applications (you may need to right-click → Open if macOS shows a security warning)
- ✅ The app will open with the Welcome Screen
- Download the
.AppImageor.debpackage from the Selfoss releases page - For AppImage: Make it executable with
chmod +x Selfoss.AppImage, then run./Selfoss.AppImage - For .deb: Install with
sudo dpkg -i selfoss.deb - ✅ Launch from your applications menu
💡 Pro Tip: Selfoss stores all your data locally on your device. No internet connection is required after installation (except for AI processing if using cloud providers).
License Activation
Section titled “License Activation”Selfoss uses LemonSqueezy for secure license management.
First Launch
Section titled “First Launch”- The Welcome Screen will appear when you first open Selfoss
- You’ll see two options:
- Enter License Key (if you’ve already purchased)
- Purchase License (redirects to purchase page)
Activating Your License
Section titled “Activating Your License”- Enter your license key in the text field
- Click “Activate License”
- Wait for validation (requires internet connection)
- ✅ Success! You’ll see a confirmation message with your plan name
- The app will automatically take you to the main dashboard
License Management
Section titled “License Management”- View your license status in Settings → License Management
- Deactivate on one device to move to another
- Lifetime licenses include all future updates
⚠️ Important: Keep your license key secure. Each key can be activated on a limited number of devices simultaneously.
Choosing Your Privacy Mode
Section titled “Choosing Your Privacy Mode”Selfoss offers flexible privacy options to match your needs:
🔒 100% Local Mode (Recommended for Privacy)
Section titled “🔒 100% Local Mode (Recommended for Privacy)”Best for: Maximum privacy, no cloud dependencies, unlimited free usage
What you need:
- Ollama installed locally (for text analysis)
- Whisper.cpp models downloaded (for transcription)
Benefits:
- ✅ Zero cloud API calls
- ✅ Complete data privacy
- ✅ No ongoing costs
- ✅ Works offline
👉 Setup Guide: See 02_PRIVACY_FIRST_SETUP_GUIDE.md
☁️ Cloud Mode
Section titled “☁️ Cloud Mode”Best for: Fast processing, no local setup required
What you need:
- OpenAI API key OR Google Gemini API key
- Internet connection
Benefits:
- ✅ Fastest processing
- ✅ No local model downloads
- ✅ State-of-the-art AI models
- ❌ Pay-per-use API costs
👉 Setup Guide: See 03_CLOUD_PROVIDER_SETUP_GUIDE.md
🔄 Hybrid Mode (Best of Both)
Section titled “🔄 Hybrid Mode (Best of Both)”Best for: Cost optimization and flexibility
Example configurations:
- Local transcription (Whisper.cpp) + Cloud analysis (OpenAI GPT-4)
- Cloud transcription (OpenAI) + Local analysis (Ollama)
👉 Setup Guide: See 13_ADVANCED_WORKFLOWS_GUIDE.md
💡 Pro Tip: Start with Cloud Mode for quick testing, then switch to Local Mode for privacy and cost savings.
First Project Setup
Section titled “First Project Setup”Projects help you organize transcripts by topic, team, or time period.
Creating Your First Project
Section titled “Creating Your First Project”- Click the ”+ New Project” button in the left sidebar
- Fill in the project details:
- Name: e.g., “Marketing Team Meetings”
- Description: Optional details about the project
- Color: Choose a color tag for visual organization
- Click “Create Project”
- ✅ Your new project appears in the sidebar
Project Organization Tips
Section titled “Project Organization Tips”- 📁 Use projects for different teams or meeting series
- 🎨 Color-code related projects (e.g., all engineering projects in blue)
- 📝 Add descriptions to help remember project context
Keyboard Shortcut: Press Ctrl+B (Windows/Linux) or Cmd+B (macOS) to toggle the sidebar
👉 Learn More: See 04_PROJECT_WORKSPACE_MANAGEMENT_GUIDE.md
Your First Transcript
Section titled “Your First Transcript”You can create transcripts in two ways: Upload a file or Record audio.
Option 1: Upload a Transcript File
Section titled “Option 1: Upload a Transcript File”- Select your project in the sidebar
- Click “Upload & Process” button in the header
- Choose your file:
- Supported formats:
.txt,.docx,.vtt,.srt - File size: 1KB - 50MB
- Must be UTF-8 encoded
- Supported formats:
- Wait for validation (automatic)
- Click “Process with LLM”
- Configure AI settings (first time only):
- Select your provider (OpenAI or Gemini)
- Enter your API key
- Choose a model
- Click “Start Analysis”
- ✅ Watch the progress indicator as AI processes your transcript
- View results: Decisions, actions, and concepts are displayed
⏱️ Processing Time: 10-30 seconds for typical meeting transcripts (depending on provider and file size)
👉 Detailed Guide: See 06_TRANSCRIPT_UPLOAD_PROCESSING_GUIDE.md
Option 2: Record Audio
Section titled “Option 2: Record Audio”- Select your project in the sidebar
- Click the microphone icon 🎤 in the header
- Allow microphone permissions (browser will prompt)
- Click “Start Recording”
- Speak or capture your meeting
- Click “Stop Recording” when done
- Transcription (automatic if enabled):
- If auto-transcribe is ON: Automatically processes
- If auto-transcribe is OFF: Use “Transcribe Audio” button later
- ✅ Your recording appears in the transcript list
⏱️ Transcription Time: Varies by provider (OpenAI: ~30 seconds, Ollama: 2-5 minutes for 1 hour)
👉 Detailed Guide: See 05_AUDIO_RECORDING_TRANSCRIPTION_GUIDE.md
Troubleshooting
Section titled “Troubleshooting”Installation Issues
Section titled “Installation Issues”Windows: “Windows protected your PC” warning
- Click “More info” → “Run anyway”
- This is normal for apps without Microsoft code signing
macOS: “App is damaged” or “Can’t be opened”
- Run:
xattr -cr /Applications/Selfoss.app - Or right-click → Open (first time only)
Linux: AppImage won’t run
- Make it executable:
chmod +x Selfoss.AppImage - Install FUSE:
sudo apt install fuse libfuse2(Ubuntu/Debian)
License Activation Issues
Section titled “License Activation Issues”“Invalid license key” error
- ✅ Check for typos or extra spaces
- ✅ Ensure you’re using the key from your purchase email
- ✅ Check your internet connection
“Maximum activations reached”
- Deactivate Selfoss on another device first
- Go to Settings → License Management → Deactivate
Empty Transcription Results
Section titled “Empty Transcription Results”Recording produces empty transcript
- ✅ Check microphone permissions in system settings
- ✅ Verify audio input is working (test in other apps)
- ✅ Ensure recording duration was at least 5 seconds
- ✅ Check API key is valid (for cloud providers)
Uploaded file fails processing
- ✅ Verify file format is supported (.txt, .docx, .vtt, .srt)
- ✅ Check file size is between 1KB and 50MB
- ✅ Ensure file is UTF-8 encoded
- ✅ Try opening file in text editor to verify content
API Connection Issues
Section titled “API Connection Issues”“API key invalid” error
- ✅ Verify you entered the correct API key
- ✅ Check API key has sufficient credits/quota
- ✅ Ensure API key is active in your provider account
“Connection timeout” error
- ✅ Check your internet connection
- ✅ Verify provider’s API status page
- ✅ Try a different model (some are faster)
👉 Full Troubleshooting Guide: See 12_TROUBLESHOOTING_FAQ_GUIDE.md
Next Steps
Section titled “Next Steps”Congratulations! 🎉 You’ve completed the Quick Start Guide.
Recommended Next Steps:
Section titled “Recommended Next Steps:”- 🔒 Set up privacy-first mode → 02_PRIVACY_FIRST_SETUP_GUIDE.md
- 📊 Learn about visualizations → 07_VISUALIZATION_DEEP_DIVE_GUIDE.md
- ✏️ Try interactive editing → 08_INTERACTIVE_EDITING_GUIDE.md
- 🔍 Master global search → 11_SEARCH_DISCOVERY_GUIDE.md
- 💾 Set up backups → 09_DATA_MANAGEMENT_GUIDE.md
Explore Advanced Features:
Section titled “Explore Advanced Features:”- Keyboard shortcuts for faster workflows
- Custom widget ordering to prioritize your views
- Batch processing for multiple transcripts
- Hybrid privacy setups for cost optimization
Get Help:
Section titled “Get Help:”- 📚 Documentation:
/docs/USER_GUIDES/ - 🐛 Bug Reports: GitHub Issues
- 💡 Feature Requests: GitHub Discussions
Happy transcribing! 🚀