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
- Install Semaphore with your preferred method: Installation.
- Log in with the admin user you created during setup, or via the
SEMAPHORE_ADMIN_*variables in Docker. - Create a project. A project isolates teams, infrastructures, or applications from each other: Projects.
- Connect what your automation needs:
- Source code with playbooks, modules, or scripts: Repositories.
- SSH keys, tokens, and passwords: Key Store.
- Target hosts and connection settings: Inventory.
- Reusable variables: Variable Groups.
- 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.
- Automate and operationalize:
- Run on a schedule: Schedules.
- Control who can do what: Teams and custom roles.
- Get alerted on results: Notifications.
Key concepts
These terms appear everywhere in the UI.
| Term | Meaning |
|---|---|
| Project | The main unit of separation. Each project has its own repositories, keys, inventories, templates, and team. Projects |
| Repository | A Git repository or local path where playbooks, modules, or scripts live. Repositories |
| Inventory | Hosts, groups, and connection settings for Ansible-style runs. Inventory |
| Variable Group | Reusable variables and environment configuration, also called Environment. Variable Groups |
| Key Store | Encrypted credentials such as SSH keys, tokens, and passwords. Key Store |
| Task Template | The definition of a run: app, repository, inventory, variables, and options. Task Templates |
| Task | A single execution of a template, with its log and status. Tasks |
| Workflow | A graph of templates with branching, approvals, and delays. Pro feature. Workflows |
| Runner | Where tasks execute: the server itself or a remote runner. Runners |
Next steps
- Put Semaphore behind TLS with a reverse proxy.
- Connect your identity provider: LDAP or OpenID Connect.
- Drive Semaphore from CI or scripts with the API and CLI.