Skip to main content

Getting Started

This page walks you from a fresh install to your first successful task. Each step links to the page with the details.

From zero to first task

  1. Install Semaphore with your preferred method: Installation.
  2. Log in with the admin user you created during setup, or via the SEMAPHORE_ADMIN_* variables in Docker.
  3. Create a project. A project isolates teams, infrastructures, or applications from each other: Projects.
  4. Connect what your automation needs:
  5. Create a task template and run it. Pick the guide for your tool: Ansible, Terraform/OpenTofu, Shell, PowerShell, or Python. Then run and watch it: Tasks.
  6. Automate and operationalize:

Key concepts

These terms appear everywhere in the UI.

TermMeaning
ProjectThe main unit of separation. Each project has its own repositories, keys, inventories, templates, and team. Projects
RepositoryA Git repository or local path where playbooks, modules, or scripts live. Repositories
InventoryHosts, groups, and connection settings for Ansible-style runs. Inventory
Variable GroupReusable variables and environment configuration, also called Environment. Variable Groups
Key StoreEncrypted credentials such as SSH keys, tokens, and passwords. Key Store
Task TemplateThe definition of a run: app, repository, inventory, variables, and options. Task Templates
TaskA single execution of a template, with its log and status. Tasks
WorkflowA graph of templates with branching, approvals, and delays. Pro feature. Workflows
RunnerWhere tasks execute: the server itself or a remote runner. Runners

Next steps