Getting Started

Welcome to Riptide! This section will explain what Riptide is and guide you through installation.

• Introduction
• Linux Installation
  • Most Linux Distributions
    • Automatic Installation
    • Manual Installation
      • Installing Requirements
      • Installing Riptide
        • Initializing the configuration
        • Allow writing to /etc/hosts
        • Shell integration
        • Systemd service
        • SSL Certificate
    • Updating Riptide
    • Next steps
  • NixOS
    • Installation
      • Via Flake
      • Via fetchTarball
    • Enable Riptide
    • Shell integration
    • Module configuration
      • services.riptide.enable
      • services.riptide.cli
      • services.riptide.cli.package
      • services.riptide.dbDrivers
      • services.riptide.dbDrivers.mongodb
      • services.riptide.dbDrivers.mongodb.enable
      • services.riptide.dbDrivers.mongodb.package
      • services.riptide.dbDrivers.mysql
      • services.riptide.dbDrivers.mysql.enable
      • services.riptide.dbDrivers.mysql.package
      • services.riptide.dockerHost
      • services.riptide.engine
      • services.riptide.engine.package
      • services.riptide.engine.name
      • services.riptide.extraConfig
      • services.riptide.plugins
      • services.riptide.plugins.phpXdebug
      • services.riptide.plugins.phpXdebug.enable
      • services.riptide.plugins.phpXdebug.package
      • services.riptide.proxy
      • services.riptide.proxy.enable
      • services.riptide.proxy.package
      • services.riptide.proxy.autostart
      • services.riptide.proxy.ports
      • services.riptide.proxy.ports.http
      • services.riptide.proxy.ports.https
      • services.riptide.proxy.url
      • services.riptide.python
      • services.riptide.repos
      • services.riptide.resolveProjectHosts
      • services.riptide.user
• MacOS Installation
  • MacOS via nix-darwin
    • Installation
      • Via Flake
      • Via fetchTarball
    • Enable Riptide
    • Shell integration
    • Module configuration
      • services.riptide.enable
      • services.riptide.cli
      • services.riptide.cli.package
      • services.riptide.dbDrivers
      • services.riptide.dbDrivers.mongodb
      • services.riptide.dbDrivers.mongodb.enable
      • services.riptide.dbDrivers.mongodb.package
      • services.riptide.dbDrivers.mysql
      • services.riptide.dbDrivers.mysql.enable
      • services.riptide.dbDrivers.mysql.package
      • services.riptide.dockerHost
      • services.riptide.engine
      • services.riptide.engine.package
      • services.riptide.engine.name
      • services.riptide.extraConfig
      • services.riptide.plugins
      • services.riptide.plugins.phpXdebug
      • services.riptide.plugins.phpXdebug.enable
      • services.riptide.plugins.phpXdebug.package
      • services.riptide.proxy
      • services.riptide.proxy.enable
      • services.riptide.proxy.package
      • services.riptide.proxy.autostart
      • services.riptide.proxy.ports
      • services.riptide.proxy.ports.http
      • services.riptide.proxy.ports.https
      • services.riptide.proxy.url
      • services.riptide.python
      • services.riptide.repos
      • services.riptide.resolveProjectHosts
      • services.riptide.user
  • Manual MacOS Setup
    • Installing Requirements
      • Installing Riptide
        • Initializing the configuration
        • Shell integration
        • SSL Certificate
    • Updating Riptide
    • Configuring shared folders (Docker Desktop)
    • Known issues under MacOS
    • Next steps
• Windows Installation
  • Installing Requirements
  • Installing Riptide
    • Initializing the configuration
    • SSL Certificate
  • Updating Riptide
  • Configuring shared drives
  • Additional Windows related notes
  • Known issues under Windows
  • Next steps
• Advanced Topics
  • Installing individual components