Skip to content

User Guide

Casey edited this page Jul 29, 2025 · 1 revision

User Guide

This guide covers everything you need to know as a regular user of Flowcase, including how to launch and use droplets, manage instances, and navigate the interface.

🚀 Getting Started

Accessing Flowcase

  1. Open your web browser and navigate to your Flowcase instance URL
  2. Login with your username and password provided by your administrator
  3. Dashboard - You'll be taken to the main dashboard where you can see available droplets

[!INFO] Password Management: Currently, users cannot change their own passwords. If you need a password change, contact your administrator. Self-service password changes are planned for future releases.

First Login

When you first login, you'll see:

  • Navigation bar with your username and logout option
  • Main content area showing available droplets
  • Running instances (if any) at the bottom of the screen

🌊 Understanding Droplets

What are Droplets?

Droplets are pre-configured containerized applications that you can launch and use through your web browser. Each droplet represents a specific application or desktop environment.

Droplet Information

Each droplet displays:

  • Name - The application or environment name
  • Description - What the droplet contains
  • Preview Image - Visual representation of the application
  • Launch Button - Click to start an instance

🎮 Using Droplets

Launching a Droplet

  1. Browse available droplets on the main dashboard
  2. Click on a droplet you want to use
  3. Review the information in the popup modal
  4. Click "Launch" to start a new instance
  5. Wait for provisioning - The system will create and configure your container
  6. Automatic redirect - You'll be taken to the droplet interface once ready

Droplet Interface

Once your droplet launches, you'll see:

  • Full-screen application or desktop environment
  • Control sidebar (toggle with the handle on the left)
  • Connection information and controls
  • File management options (if enabled)

🎛️ Control Panel Features

Sidebar Navigation

The control panel provides access to:

Connection Controls

  • Reconnect - Refresh the connection
  • Disconnect - Close the session
  • Fullscreen - Toggle fullscreen mode

File Management

  • Upload Files - Drag and drop or browse to upload
  • Download Files - Access files from the container
  • File Browser - Navigate the container filesystem

Settings

  • Resolution - Adjust screen resolution
  • Keyboard Layout - Change keyboard mapping
  • Audio - Configure audio settings

Keyboard Shortcuts

Shortcut Action
F11 Toggle fullscreen
Ctrl+Alt+F Toggle control panel
Ctrl+Alt+R Reconnect
Ctrl+Alt+D Disconnect

📁 File Management

Uploading Files

  1. Open the control panel by clicking the sidebar handle
  2. Navigate to "Upload" section
  3. Drag and drop files into the upload area, or
  4. Click browse to select files from your computer
  5. Monitor upload progress in the progress bar
  6. Files appear in the container's designated upload folder

Downloading Files

  1. Access the file browser in the control panel
  2. Navigate to the file you want to download
  3. Right-click on the file and select "Download", or
  4. Use the download button if available

File Locations

  • Upload Folder: /home/user/uploads/ (or as configured)
  • Desktop: /home/user/Desktop/
  • Documents: /home/user/Documents/
  • Downloads: /home/user/Downloads/

Warning

File Persistence: By default, files in droplet instances are temporary and will be lost when the instance is destroyed. Only upload/download files you need to preserve between sessions. Contact your administrator about persistent storage options if available.

🖥️ Instance Management

Viewing Your Instances

Running instances appear at the bottom of the dashboard:

  • Thumbnail preview - Live screenshot of the running application
  • Instance name - Shows the droplet name
  • Quick actions - Connect or destroy options

Instance Actions

Connecting to Instances

  • Click the thumbnail to view the instance popup
  • Click "Connect" to open the instance in a new window
  • Direct URL - Each instance has a unique URL for direct access

Destroying Instances

  • Click the thumbnail to open the popup
  • Click "Destroy" to terminate the instance
  • Confirm the action in the popup dialog
  • Data loss warning - All unsaved work will be lost

Instance Lifecycle

  1. Provisioning - Container is being created and configured
  2. Starting - Application is initializing
  3. Running - Instance is ready for use
  4. Stopping - Instance is being shut down
  5. Destroyed - Instance and data are removed

Warning

Data Loss Prevention: When you destroy an instance, ALL data inside the container is permanently lost unless persistent storage is configured. Always download important files before destroying instances.

🔧 Settings and Preferences

Display Settings

Access display settings through the control panel:

Resolution

  • Choose from preset resolutions
  • Custom resolution input
  • Automatic browser detection

Scaling

  • Fit to window
  • Original size
  • Custom zoom levels

Audio Configuration

Configure audio settings:

  • Enable/Disable audio streaming
  • Volume control
  • Audio codec selection (if available)

Keyboard and Input

Customize input settings:

  • Keyboard layout selection
  • Mouse sensitivity
  • Touch screen support (mobile devices)

📱 Mobile Usage

Mobile Browser Support

Flowcase works on mobile devices with some considerations:

  • Touch navigation - Use touch gestures for mouse input
  • Virtual keyboard - On-screen keyboard for text input
  • Orientation - Landscape mode recommended
  • Zoom controls - Pinch to zoom in/out

Mobile-Specific Features

  • Touch keyboard toggle
  • Gesture controls for right-click and scrolling
  • Fullscreen mode for better experience

🔄 Session Management

Session Persistence

  • Automatic save - Session state is preserved
  • Reconnection - Resume your session after disconnection
  • Timeout - Sessions expire after inactivity (configured by admin)

Multiple Sessions

  • Multiple droplets - Run several instances simultaneously
  • Browser tabs - Open instances in different tabs
  • Session isolation - Each instance is independent

🚫 Common Issues and Solutions

Connection Problems

Issue: Cannot connect to droplet Solutions:

  • Refresh the browser page
  • Check internet connection
  • Try a different browser
  • Contact administrator

Issue: Slow performance Solutions:

  • Close unnecessary browser tabs
  • Check network bandwidth
  • Reduce screen resolution
  • Contact administrator about server resources

Display Issues

Issue: Screen appears cut off Solutions:

  • Adjust browser zoom level
  • Change droplet resolution
  • Try fullscreen mode
  • Use landscape orientation on mobile

Issue: Blurry or pixelated display Solutions:

  • Increase resolution setting
  • Check network connection quality
  • Disable browser extensions
  • Try hardware acceleration

File Upload Problems

Issue: Files won't upload Solutions:

  • Check file size limits
  • Verify file type permissions
  • Try smaller files first
  • Contact administrator

Issue: Uploaded files not visible Solutions:

  • Check upload folder location
  • Refresh file browser
  • Verify upload completion
  • Contact administrator

💡 Tips and Best Practices

Performance Optimization

  • Close unused applications within the droplet
  • Use appropriate resolution for your screen
  • Maintain good network connection
  • Clear browser cache regularly

Data Management

  • Save work frequently within applications
  • Download important files before destroying instances
  • Use cloud storage for persistent data when possible
  • Backup critical work externally - do not rely on instance storage

Important

File Persistence Policy: Unless your administrator has configured persistent storage for specific droplets, all files and changes within instances are temporary. Plan your workflow accordingly and always save important work externally.

Security Best Practices

  • Log out when finished
  • Don't share credentials with others
  • Use strong passwords (if you can change them)
  • Be cautious with sensitive data
  • Report issues to administrators

🆘 Getting Help

Self-Help Resources

  1. Refresh the page - Solves many temporary issues
  2. Try different browser - Compatibility check
  3. Check network connection - Ensure stable internet
  4. Clear browser cache - Remove temporary files

Contacting Support

When contacting your administrator, provide:

  • Your username
  • Droplet name you're trying to use
  • Error messages (screenshot if possible)
  • Browser and version you're using
  • Steps to reproduce the issue

System Status

Check with your administrator about:

  • Scheduled maintenance times
  • System resource limits
  • Available droplets and updates
  • Policy changes or new features

📈 Advanced Usage

Power User Features

  • Bookmarking instances - Save direct links to running instances
  • Multi-monitor setup - Use multiple browser windows
  • Keyboard shortcuts - Learn efficiency shortcuts
  • Custom workflows - Develop personal usage patterns

Integration with Other Tools

  • Screen recording - Use browser extensions to record sessions
  • Note taking - Keep external notes about your work
  • Time tracking - Monitor usage for productivity
  • Collaboration - Share screens through browser sharing

📋 Quick Reference

Essential Actions

Action Steps
Launch droplet Dashboard → Click droplet → Launch
Connect to instance Bottom bar → Click thumbnail → Connect
Upload file Control panel → Upload → Drag/drop
Destroy instance Thumbnail → Destroy → Confirm
Logout Username menu → Logout

Keyboard Shortcuts

Shortcut Action
F11 Fullscreen
Ctrl+Alt+F Toggle sidebar
Ctrl+Alt+R Reconnect

Need more help? Check the FAQ or Troubleshooting Guide for additional assistance.

Clone this wiki locally