Site index

Home

• ck-git-hosting
  • Start with a project
  • What would you like to do?
  • Reference and administration

Guides

• Set up the client
  • Connect your device
  • Configuration
  • SSH connections
• Publish and sync projects
  • Publish a project
  • Sync committed changes
• Clone and update projects
  • Find projects
  • Fetch and update
• Manage local checkouts
  • Main checkout
  • Inspect and select checkouts
  • Stop managing a checkout
• Web dashboard tour
  • Projects at a glance
  • Project overview
  • Browse source and documentation
  • Follow a CI run
• Follow builds and download releases
  • Follow a build
  • Download a release
• Read CI results and logs
  • Push and read results
  • Watch and cancel a run

Server

• Server installation and pairing
  • What the installer changes
  • Install
  • Pair a device
  • Open the dashboard
  • Upgrade
  • Uninstall
• Packages, continuous integration, and releases
  • What is built where
  • Continuous integration
  • Debian and Raspberry Pi
  • Other Linux distributions
  • macOS client with Homebrew
  • Cutting a release
• Manage hosted projects
  • Create a repository
  • Change the default branch
  • Checkout registration and metadata
  • Remove a hosted project
• Backup and recovery
  • Save and verify a backup
  • Restore a complete server backup
  • Recover a removed project
• Self-hosted releases and deployment
  • Two channels, one version rule
  • The self-hosted flow, step by step
  • The trust boundary
  • Automatic deployment
  • Deploying your own project
  • Upgrade notes
  • Updating the client

CI

• Run your first CI workflow
  • Enable CI for a project
  • Write .ckgit/ci.yml
  • Next steps
• Configure and operate the CI runner
  • What the package installs
  • Configure the runner
  • Leases and requeueing
  • Sizing on a Raspberry Pi
  • The sandbox and its requirements
  • Operate the service
• Share CI load with remote runners
  • How jobs are shared
  • What happens when a runner goes away
  • What a runner sends back
  • Live view
  • Set up a remote runner
  • runner.ini
  • Server settings
  • Manage runners
  • Security
• Build artifacts and caches
  • Sister projects and build caches
  • Build artifacts and retention
• Create and download releases
  • Releases
  • Deploying ck-git-hosting's own release
• Host project sites with Pages
  • Pages
  • Serving it on the intranet
• .ckgit/ci.yml reference
  • File location and reading rules
  • Syntax
  • Schema table
  • Trigger matrix
  • Checkout and history
  • Artifacts, releases, and Pages
  • Bounds table
  • Troubleshooting
• CI execution environment
  • Execution
  • Environment
  • Filesystem
  • Version-stamping recipe
• CI workflow examples
  • Worked examples

ckdocs

• Get started with ckdocs
  • Build your first site
  • Preview locally
  • Build several sites at once
  • Continue with a guide
• Pages and navigation
  • How pages are found, named, and ordered
• Page titles and metadata
  • Front matter
• Site configuration
  • ckdocs.yml reference
  • Search
  • Several sites in one build
  • Output layout
  • Sites from other branches
  • Redirects
• Markdown, links, and assets
  • Markdown
  • Links and assets
• Publish a documentation site
  • Publishing on ck-git Pages and GitHub Pages
  • Several sites from several branches
• Mermaid diagrams
  • Diagram examples
  • Flows and systems
  • Software models
  • Sequences
  • Charts
  • Planning and history
• Flows and systems
  • Flowchart
  • Mindmap
  • Block diagram
  • Architecture
  • C4 diagram
  • Packet diagram
• Software models
  • Class diagram
  • State diagram
  • Entity-relationship
  • Requirement diagram
• Sequences
  • Sequence diagram
  • ZenUML sequence
• Charts
  • Pie chart
  • XY chart
  • Radar chart
  • Quadrant chart
  • Sankey diagram
  • Treemap
• Planning and history
  • Gantt chart
  • Timeline
  • User journey
  • Kanban board
  • Git graph

Reference

• Command-line reference
  • Commands
• Dashboard behavior and limits
  • Projects and revisions
  • Dashboard tunnel
• Build from source
  • Compile and test
• SSH and control protocol version 1
  • SSH forced command
  • Receive-hook identity handoff
  • Control socket framing
  • Default branch operations
  • CI operations
  • Runner keys
  • Compatibility rule