DOCSEARCHbyAlgolia
Submit Docs

ServBay Documentation

website·Indexed 33 days ago

https://support.servbay.com/

Guides for setting up and running local development environments on macOS. Includes instructions for configuring PHP frameworks (Laravel, Symfony, Slim, Phalcon, ThinkPHP 8, Swoole, Workerman, Webman), Node.js projects (React, Socket.io), Ruby, and various PHP extensions such as Redis, MongoDB, Imagick, and MySQL.

Tokens
215.1K
Snippets
775
Records
1.6K
Agent score
61%

What's inside ServBay

  1. Overview of ServBay DNS Management

    ServBay provides a DNS Management Panel to handle domain resolution for local development environments. It allows developers to map custom domain names to local IP addresses (typically 127.0.0.1 or ::1) using two primary methods: a built-in DNS server (for .servbay.demo domains) and the system's /etc/hosts file. This eliminates the need for manual terminal-based editing of the hosts file and allows for a production-like local environment.

  2. Overview of ACME SSL certificates in ServBay

    ServBay uses the ACME (Automated Certificate Management Environment) protocol to automate the issuance, renewal, and revocation of SSL/TLS certificates for local development. It primarily utilizes DNS-01 validation, which requires adding a TXT record to the domain's DNS configuration. This method is advantageous because the local development environment does not need to be publicly accessible, and it bypasses potential firewall or ISP blocks on ports 80/443.

    Supported Certificate Authorities (CAs) include:

    • ZeroSSL (Preferred default)
    • Let's Encrypt
    • Google Trust Services

  3. Overview of ServBay local development platform

    ServBay is an integrated local development environment platform for web developers that bundles essential tools to eliminate manual installation of dependencies or the overhead of containerization (like Docker). It allows developers to configure environments quickly and switch between software versions via an intuitive user interface.

    Supported components include:

    • Programming Languages: PHP, Node.js, Python, Go, Java, .NET, Ruby, Rust, and others.
    • SQL Databases: MySQL, MariaDB, PostgreSQL, MongoDB.
    • NoSQL Databases: Redis, Memcached.
    • Web Servers: Caddy, Nginx, Apache.
    • Additional Services: DNS services, mail services, SSL certificate management, and AI/LLM solutions (e.g., Ollama).

  4. Overview of ServBay SSL Certificate Support

    ServBay provides integrated SSL/TLS certificate management to enable HTTPS in local development environments. This allows developers to simulate production environments, use secure-context features (like Service Workers, Geolocation API, and WebRTC), and avoid browser security warnings. ServBay supports domain certificates for web traffic as well as specialized certificates for code signing, email signing (S/MIME), and document signing.

  5. Overview of ServBay AI Gateway capabilities

    ServBay AI Gateway acts as a local unified entry point for AI-native development. It solves the problem of managing fragmented providers and keys by providing:

    • Unified Access: A single local entry point for multiple AI providers.
    • Virtual Key Management: The ability to use virtual keys instead of exposing real provider keys to every tool.
    • Centralized Monitoring: A single view for tracking usage, costs, and latency across different AI services.
    • Tool Integration: Simplified connection of various AI coding tools to a unified gateway.

  6. Overview of the ServBay Development Library

    The ServBay Development Library provides core development resources, including header files (.h), static libraries (.a), and libtool archives (.la). It is designed for advanced users who need to compile custom software, build specific modules, or extend ServBay. This library ensures that compiled code is compatible with ServBay's integrated components such as PHP, PostgreSQL, and OpenSSL. Typical users who only run websites or databases do not need to install this package.

  7. Overview of PHP MySQL extensions in ServBay

    ServBay comes with three key MySQL database extensions pre-installed and enabled by default for all supported PHP versions. No manual setup or php.ini modification is required to start using them.

    • MySQL Native Driver (mysqlnd): The underlying C-native driver that provides core communication between PHP and MySQL/MariaDB. It is the foundation for both mysqli and PDO_MySQL.
    • MySQLi (mysqli): An improved extension specifically for MySQL and MariaDB, offering both object-oriented and procedural interfaces. It supports prepared statements, transactions, and stored procedures.
    • PDO MySQL (PDO_MySQL): A driver for PHP Data Objects (PDO) that provides a unified database abstraction layer. It is recommended for new projects due to its database portability (allowing easier switching between MySQL, PostgreSQL, SQLite, etc.) and consistent API.

  8. Overview of S/MIME Email Security

    S/MIME (Secure/Multipurpose Internet Mail Extensions) is a security protocol based on Public Key Infrastructure (PKI) that provides two primary functions:

    1. Digital Signature: Uses a private key to sign email content. Recipients use the sender's public key to verify the signature, ensuring authenticity (the sender is who they claim to be) and integrity (the content was not tampered with).
    2. Email Encryption: Uses the recipient's public key to encrypt content. Only the recipient with the corresponding private key can decrypt it, ensuring confidentiality.

    For developers, this is used to protect sensitive data such as API keys, project details, or source code during email exchanges.

  9. Overview of SQLite support in ServBay

    ServBay provides an integrated SQLite database module for PHP development. The relevant PHP extensions (sqlite3 and pdo_sqlite) are pre-installed and enabled by default across all supported PHP versions in ServBay. This allows developers to use SQLite for data storage without manual installation or server configuration, as the entire database is stored in a single .sqlite file.

  10. Overview of PHP GD module in ServBay

    ServBay for macOS includes the PHP GD (Graphics Draw) image processing module pre-installed and enabled by default for all supported PHP versions. The GD library allows developers to dynamically create and manipulate images, supporting formats such as JPEG, PNG, GIF, WBMP, and XPM.

  11. Overview of ServBay Team for distributed development

    ServBay Team is a collaboration platform designed for distributed development teams to eliminate environment inconsistencies (the "works on my machine" problem). It allows team leaders to centrally manage, distribute, and update shared environment configurations, ensuring all members use the same package versions and settings across development, testing, and production.

  12. Overview of ServBay Local DNS Management

    ServBay integrates a local dnsmasq server to allow developers to access local applications using custom domain names (e.g., servbay.demo) without manually editing the system's /etc/hosts file.

    Important Constraint: DNS records for projects created via the Sites feature (marked with a globe 🌐 icon) are linked to the Sites configuration and must be managed within the Sites section. The DNS Server interface only manages manually added records not tied to a specific ServBay Site.