← All 19 apps

Self-hostable Git server with SSH (authorized keys), Git (git://), and HTTP endpoints. Users, repos, access control, and optional LFS — all driven by a config file.

Install

composer require sugarcraft/candy-serve

Quickstart

use SugarCraft\Serve\{AccessControl, Config, Repo, User};
use SugarCraft\Serve\Git\GitDaemon;

$config = Config::fromDefaults();        // CANDY_SERVE_* env vars, else defaults
                                         // (Config::load($yamlPath) reads a config file)

// Describe a repository and create it as a bare git repo on disk
$repo = Repo::new('my-project', $config->reposPath() . '/my-project.git')
    ->withDescription('Greeting service')
    ->withPublic(true)
    ->addCollaborator('alice')
    ->init();

// Ask the permission matrix
$acl = AccessControl::getInstance();
$acl->canWrite(User::new('alice'), $repo);   // true  (collaborator)
$acl->canWrite(User::new('bob'), $repo);     // false
$acl->canRead(null, $repo);                  // true  (public repo, anonymous read)

// Serve it over git:// (blocks; serveAsync() runs on a ReactPHP loop instead)
$daemon = new GitDaemon($config);
$daemon->registerRepo($repo);
$daemon->serve();

What's in the box

Source & demos

• Source on GitHub
• Full README
• Runnable examples
• Port of charmbracelet/soft-serve (Go upstream)

Try the quickstart →

API

Class	Method	Description
Config	static fromDefaults() / static load(path)	Configuration from env + defaults, or from a YAML file
Config	reposPath() / sshPath() / dbPath() / lfsPath()	Data directories
Repo	static new(name, path) / withDescription() / withPublic() / withPrivate() / withVisibility() / withAllowPush() / addCollaborator()	Immutable repository description
Repo	init() / path() / branches()	Create the bare repository; inspect it
User	static new(username) / withAdmin() / withAuthorizedKeys() / addAuthorizedKey()	Immutable user account with SSH keys
AccessControl	static getInstance() / canRead() / canWrite() / canAdmin()	Permission checks
SSHServer	__construct(Config) / registerUser() / registerRepo() / handleConnection(stream, username, command, publicKey)	SSH command dispatcher
GitDaemon	__construct(Config) / registerRepo() / serve(pidFile) / serveAsync(loop, pidFile) / shutdown()	git:// protocol daemon
HttpSmartProtocol\Server	__construct(Config) / registerRepo() / registerUser() / handleRequest(…)	Smart-HTTP endpoint

Demos.

VHS-recorded GIFs of every example shipped with the library. Regenerated automatically on every push that touches the source.