Flowcase is a free and completely open-source alternative to Kasm Workspaces, enabling secure container streaming for your applications. Stream desktop applications, development environments, and more through your web browser using Docker containers.

Windows (PowerShell):

.\install.ps1

Linux/Mac:

chmod +x install.sh
./install.sh

The installation script will:

• ✅ Check prerequisites
• ✅ Generate secure passwords
• ✅ Create configuration files
• ✅ Start all services
• ✅ Display access information

1. Clone the repository:

   git clone https://github.com/flowcase/flowcase.git
   cd flowcase

2. Create .env file:

   cp .env.example .env
   # Edit .env with your configuration

3. Start Flowcase:

   docker compose up -d

4. View logs for credentials:

   docker compose logs -f

5. Access Flowcase:

   • Open http://localhost or https://localhost
   • Use the default admin credentials shown in the logs

Before installing Flowcase, ensure you have:

• Docker (version 20.10 or later)

  • Download Docker Desktop
  • Verify: docker --version

• Docker Compose (version 2.0 or later)

  • Usually included with Docker Desktop
  • Verify: docker compose version

• System Requirements:

  • At least 2GB RAM
  • 10GB free disk space
  • Network access for downloading images

• Permissions:

  • Linux/Mac: User in docker group or sudo access
  • Windows: Docker Desktop running with WSL2

• SETUP.md - Comprehensive setup guide with detailed instructions

  • Configuration options
  • Authentik integration
  • Troubleshooting
  • Production deployment

• SECURITY.md - Security information and reporting

Create a .env file with the following variables:

Generate secure values:

# Generate PostgreSQL password
openssl rand -base64 24

# Generate Authentik secret key
openssl rand -base64 32

For local development, use these settings:

DOMAIN=localhost
ADMIN_EMAIL=[email protected]
CA_SERVER=https://acme-staging-v02.api.letsencrypt.org/directory
PG_PASS=<generate-secure-password>
AUTHENTIK_SECRET_KEY=<generate-secure-key>

For production deployment:

DOMAIN=flowcase.yourdomain.com
ADMIN_EMAIL=[email protected]
CA_SERVER=https://acme-v02.api.letsencrypt.org/directory
PG_PASS=<strong-random-password-32-chars>
AUTHENTIK_SECRET_KEY=<strong-random-key-50-chars>

1. Navigate to http://localhost or https://localhost
2. Use the default credentials displayed in the terminal logs:
   • Username: admin
   • Password: <random-generated-password>

Authentik integration is disabled by default. To enable it:

1. Configure Authentik (see SETUP.md for detailed steps):

   • Access Authentik Admin: https://authentik.localhost
   • Create a Proxy Provider
   • Create an Application
   • Configure the Outpost

2. Enable Authentik in docker-compose.yml:

   • Uncomment the middleware line (line 41): - traefik.http.routers.flowcase.middlewares=authentik@file
   • Uncomment the flag (line 24): --traefik-authentik
   • Restart: docker compose restart web nginx traefik

3. Access Flowcase: https://localhost (will redirect to Authentik for login)

# Start Flowcase
docker compose up -d

# View logs
docker compose logs -f

# View logs for specific service
docker compose logs -f web

# Stop Flowcase
docker compose down

# Restart services
docker compose restart

# Check service status
docker compose ps

Flowcase consists of the following components:

• Flowcase Web: Main application server (Flask)
• Nginx: Reverse proxy for Flowcase
• Traefik: Reverse proxy and load balancer with automatic HTTPS
• Authentik: Identity provider (optional, for authentication)
• PostgreSQL: Database for Authentik
• Redis: Cache for Authentik

# Check logs
docker compose logs

# Check service status
docker compose ps

• Ensure containers are running: docker compose ps
• Check nginx logs: docker compose logs nginx
• Try http://localhost instead of https://localhost

For localhost development, certificate warnings are expected. For production:

• Use a proper domain name
• Update DOMAIN in .env
• Ensure DNS points to your server

⚠️ Warning: This will delete all data!

docker compose down -v
docker compose up -d

For more troubleshooting help, see SETUP.md.

Contributions are welcome! Please feel free to:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request

Please read our contributing guidelines and code of conduct before submitting.

• Security Issues: Please report security vulnerabilities to the maintainers privately (see SECURITY.md)
• Updates: Keep your installation updated with the latest releases
• Credentials: Always use strong, randomly generated passwords
• Production: Follow the production deployment checklist in SETUP.md

This project is licensed under the MIT License - see the LICENSE file for details.

• Documentation: Check SETUP.md for detailed guides
• Issues: Open an issue on GitHub
• Discussions: Join discussions on GitHub Discussions

• Production-ready release
• Upgrade/migration support
• Additional authentication providers
• Enhanced container management
• Performance optimizations
• Additional documentation