Development environment

• Development environment installation
  • Requirements
  • Recommended setup
  • Vagrant setup
  • Advanced setup
  • Slow internet connections
  • Installing remotely
  • Next steps
• Recommended setup
  • Requirements
  • Step 0: Set up Git & GitHub
  • Step 1: Install prerequisites
    • macOS
    • Ubuntu
    • Debian
    • Fedora
    • Windows 10
  • Step 2: Get Zulip code
  • Step 3: Start the development environment
  • Step 4: Developing
    • Where to edit files
    • Understanding run-dev debugging output
    • Committing and pushing changes with Git
    • Maintaining the development environment
    • Rebuilding the development environment
    • Shutting down the development environment for use later
    • Resuming the development environment
  • Next steps
  • Troubleshooting and common errors
    • Vagrant guest doesn’t show (zulip-py3-venv) at start of prompt
    • Vagrant was unable to mount VirtualBox shared folders
    • ssl read error
    • Unmet dependencies error
    • ssh connection closed by remote host
    • os.symlink error
    • Hyper-V error messages
    • Connection timeout on vagrant up
    • Vagrant was unable to communicate with the guest machine
    • Vagrant up fails with subprocess.CalledProcessError
    • VBoxManage errors related to VT-x or WHvSetupPartition
    • OSError: [Errno 26] Text file busy
  • Specifying an Ubuntu mirror
  • Specifying a proxy
  • Using a different port for Vagrant
  • Customizing CPU and RAM allocation
• Advanced setup
  • Installing directly on Ubuntu, Debian, CentOS, or Fedora
  • Installing using Vagrant with VirtualBox on Windows 10
    • Running Git BASH as an administrator
  • Using the Vagrant Hyper-V provider on Windows (beta)
    • Problems you may encounter
  • Newer versions of supported platforms
• Using the development environment
  • Common
  • Server
  • Web
  • Mobile
• Developing remotely
  • Connecting to the remote environment
  • Setting up user accounts
  • Setting up the development environment
  • Running the development server
  • Making changes to code on your remote development server
    • Editing locally
    • Editing remotely
    • Next steps
  • Using an nginx reverse proxy
• Authentication in the development environment
  • Email and password
  • Google
  • GitHub
  • GitLab
  • Apple
  • SAML
  • When SSL is required
  • Testing LDAP in development
    • Testing avatar and custom profile field synchronization
    • Automated testing
  • Two factor authentication
  • Password form implementation
• Testing the installer
  • Configuring
  • Running a test install
    • Build and unpack a release tarball
    • Test an install
    • See running containers after installation
    • Connect to a running container
    • Stopping and destroying containers
    • Iterating on the installer