User Documentation

This section contains details about how to use and configure Riptide for daily use.

For setting up new projects with Riptide, see the Configuration Guide.

Warning

Make sure to read the Getting Started section first.

• Configuration
  • Initial configuration
  • Proxy server configuration
  • Repository configuration
  • Engine configuration
  • Editing the configuration file manually
  • Resolving hostnames and hosts-file
    • Manual routing
• Shell Integration
  • CLI Command Aliases
    • Install the integration
  • Autocomplete
• Proxy Server Setup
  • Proxy Server URL
  • Proxy Server HTTP/HTTPS Ports
  • Start the Proxy on system boot
    • Other platforms
  • Starting the Proxy Server manually
    • Linux, ports <= 1024
    • Mac , ports <= 1024
    • All other platforms
  • Running the Proxy Server behind Nginx or Apache
    • Nginx
    • Apache
  • Import the SSL certificate authority
    • Location
    • Chrome
    • Firefox
  • Auto-Start services
• Project Setup
  • Running the first-time setup
  • Next steps
• Working with Riptide
  • Access your projects web services
  • Access other TCP/UDP ports
  • Running CLI commands
  • Starting and stopping services via CLI
  • Running services in foreground
  • A note about paths and directories
  • Directly access the shell of a service
• Managing Databases
  • Listing environments and status
  • Creating a new environment
  • Importing and exporting
  • Copying
  • Deleting
• Importing Files
• Log Files
  • riptide log
    • Example
  • View files manually
• Hooks
  • Controlling when hooks are run
    • Timeouts
  • Examples
    • Running a linter before commiting
    • Running a setup command before starting
    • Running a custom command from a Makefile
    • Running a command after stopping any project
  • List of events
  • Hook concepts
    • Configuration
    • Using a command from the app
    • Using a custom command
  • Custom events
  • Plugins
• Using Repositories
• PHP Debugging with XDebug
  • See Status of XDebug
  • Enable / Disable XDebug
  • Xdebug Mode
  • Activation method
  • Additional configuration
  • Xdebug Version
  • Enable XDebug in PHPStorm
• Performance Optimizations
  • Configurable Performance Optimizations
    • Named Volumes instead of Host-Path volumes (dont_sync_named_volumes_with_host)
    • Do not synchronize unimportant paths with the host system (dont_sync_unimportant_src)
  • Platform-specific optimizations
    • MacOS