Welcome to Debusine’s documentation!

The documentation is structured by following the Diátaxis principles: tutorials and explanation are mainly useful to discover and learn, howtos and reference are more useful when you are familiar with debusine already and you have some specific action to perform or goal to achieve.

If you are new to debusine, you will want to read Introduction to Debusine first.

Tutorials

• Install your first debusine instance
• Getting started with debusine
  • Pre-requisites
  • Submitting a work request
  • Creating an artifact
  • Creating an sbuild work-request using an artifact
  • Creating a work request with a notification

Explanations

• Introduction to Debusine
  • What is Debusine
  • Debusine for Debian development
  • Next generation Debian infrastructure
  • Run distribution-wide QA experiments
  • Current development plan
  • Learn more
• Why this project
  • A central place for tasks processing the Debian archive
  • Including package building
  • With custom workflows
  • And GitLab integration
  • Conclusion
• Debusine concepts
  • Artifacts
  • Workspaces
  • Tasks
  • Workflows

Todo

Add new explanation pages to cover:

• architecture (server, worker, client)

• work request scheduling (with work request status in all steps)

How-to guides

• Set up debusine-client
  • Introduction
  • Initial setup
  • Test the configuration
• Create an API token
  • As a debusine user
  • As a debusine administrator
  • Next steps
• Tasks for administrators
  • Set up a debusine server
  • Set up a debusine worker
  • Add a new worker
  • Add a new user
  • Enable logins with GitLab accounts
• Contribute to debusine
  • Join the community
  • Where to start?
  • How to contribute
  • Test latest devel branch code
  • Write access to the git repository
  • Django Debug Toolbar

Reference

• Tasks
  • Ontology for generic tasks
  • Specifications of tasks
• Artifacts
  • Category debian:source-package
  • Category debian:binary-packages
  • Category debian:upload
  • Category debian:package-build-log
  • Category debian:system-tarball
  • Category debian:system-image
  • Category debusine:work-request-debug-logs
• Frequently Asked Questions about Debusine
  • Design choices
• Runtime environment
• Package repositories
  • The Debian repository
  • The upstream repository
  • The snapshot repository
  • The bullseye-backports repository
• The debusine-admin command
  • Managing workers
  • Managing users
  • Manage workspaces
  • Manage work requests
  • Manage notification channels
  • Managing tokens
  • Administrative commands
• The debusine command
  • Output of the debusine command
  • Return values
  • Sub-commands
• Reference for debusine contributors
  • Design goals
  • Team organization
  • Coding practices
  • Internal API

Todo

Add new reference pages to cover:

• debusine-client configuration file

• debusine-server configuration file

• debusine-worker configuration file

Indices and tables

• TODO to fix in the documentation

• Index

• Module Index