Get started

1. 01

   Install Orbit

   Run the installer. Orbit starts a small background service, which keeps your sites running even when the window is closed, and puts the sgt command on your PATH.

2. 02

   Serve a project

   In Sites, choose Link a folder — or park a directory to serve every folder in it. The site answers at its folder name under .test.

                     
                       
                           $ 
                           sgt link ~/code/shop
                         
                           $ 
                           sgt park ~/code
                         
                     
                   

3. 03

   Choose the web server and PHP

   Settings › Web server switches every site at once. Each site keeps its own PHP version.

                     
                       
                           $ 
                           sgt settings --web-server caddy
                         
                           $ 
                           sgt link ~/code/shop --php 8.3
                         
                     
                   

4. 04

   Add a database

   In Services, add MySQL, MariaDB, PostgreSQL, Redis, Valkey or Mailpit, then link it to a site: Orbit writes the connection into the project.

                     
                       
                           $ 
                           sgt service add mysql --version 8.0
                         
                           $ 
                           sgt service list
                         
                     
                   

5. 05

   Turn on HTTPS

   Trust the local certificate authority once (Windows asks you to confirm), then serve any site over HTTPS.

                     
                       
                           $ 
                           sgt https trust
                         
                           $ 
                           sgt link ~/code/shop --https
                         
                     
                   

6. 06

   Check a site

   When something looks wrong, check the site as a browser would: status, timing, DNS, and the PHP and server errors raised meanwhile.

                     
                       
                           $ 
                           sgt status
                         
                           $ 
                           sgt check shop.test
                         
                           $ 
                           sgt logs
                         
                     
                   

Every command explains itself: run sgt help, or sgt help <command>.