# Shipyard

> Shipyard is an open-source, self-hosted platform for deploying containers to your own servers on Docker Swarm: git and image deploys, automatic HTTPS through Traefik, persistent volumes, a live topology canvas, edge functions, sandbox apps and a built-in OCI registry.

Every page below is plain Markdown. `/llms-full.txt` holds all of them in one file.

## Docs

- [Guide](https://shipyard.trian.space/docs/guide.md): Install Shipyard, then manage organizations, projects, services, deployments and infrastructure.
- [API reference](https://shipyard.trian.space/docs/api.md): Shipyard's Open API: authentication, scopes, endpoints and response formats for CI/CD and automation.
- [Edge functions](https://shipyard.trian.space/docs/edge-functions.md): Deploy TypeScript functions from a git repository to Shipyard's Deno runtime.
- [Sandbox apps](https://shipyard.trian.space/docs/sandbox.md): Write and preview small apps in the browser with Shipyard's in-browser editor.
- [Container registry](https://shipyard.trian.space/docs/registry.md): Push, pull and deploy Docker images and static site bundles from Shipyard's built-in OCI registry.
- [Nomi integration](https://shipyard.trian.space/docs/nomi.md): Instructions for the coding agent implementing Nomi's Shipyard integration: org provisioning, dev databases, secrets, publish, environments, webhooks and termination.
- [Design system](https://shipyard.trian.space/docs/design-system.md): Drydock, the visual language of the Shipyard dashboard — tokens, type, components and the rules that keep them consistent.

## For coding agents

- [Nomi integration](https://shipyard.trian.space/docs/nomi.md): implementing a platform on top of Shipyard (org provisioning, dev databases, secrets, publish, environments, webhooks). Read it whole before writing integration code.

## Optional

- [Full documentation](https://shipyard.trian.space/llms-full.txt): every page concatenated
- [Source code](https://github.com/triandamai/shipyard): Rust backend, SvelteKit dashboard