-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' of github.com:semaphoreui/semaphore into develop
- Loading branch information
Showing
1 changed file
with
68 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,87 @@ | ||
| # Semaphore UI (formerly Ansible Semaphore) | ||
| # Semaphore UI | ||
|
|
||
| Modern UI for Ansible, Terraform, OpenTofu, PowerShell and other DevOps tools. | ||
|
|
||
| [](https://discord.gg/5R6k7hNGcH) | ||
| [](https://www.youtube.com/@semaphoreui) | ||
| <!-- [](https://semaphoreui.com/install/docker/) --> | ||
|
|
||
|  | ||
|
|
||
| Semaphore is a modern UI for Ansible, Terraform/OpenTofu, Bash and Pulumi. It lets you easily run Ansible playbooks, get notifications about fails, control access to deployment system. | ||
| If your project has grown and deploying from the terminal is no longer feasible, then Semaphore UI is the tool you need. | ||
|
|
||
| If your project has grown and deploying from the terminal is no longer for you then Semaphore UI is what you need. | ||
| ## Live Demo | ||
|
|
||
|  | ||
| Try the latest version of Semaphore at [https://cloud.semaphoreui.com](https://cloud.semaphoreui.com). | ||
|
|
||
|
|
||
| ## What is Semaphore UI? | ||
|
|
||
| Semaphore UI is a modern web interface for popular DevOps tools. | ||
|
|
||
| Semaphore UI allows you to: | ||
| * Easily run Ansible playbooks, Terraform and OpenTofu code, as well as Bash and PowerShell scripts. | ||
| * Receive notifications about failed tasks. | ||
| * Control access to your deployment system. | ||
|
|
||
| ## Installation | ||
| ## Key Concepts | ||
|
|
||
| 1. **Projects** is a collection of related resources, configurations, and tasks. Each project allows you to organize and manage your automation efforts in one place, defining the scope of tasks such as deploying applications, running scripts, or orchestrating cloud resources. Projects help group resources, inventories, task templates, and environments for streamlined automation workflows. | ||
| 2. **Task Templates** are reusable definitions of tasks that can be executed on demand or scheduled. A template specifies what actions should be performed, such as running Ansible playbooks, Terraform configurations, or other automation tasks. By using templates, you can standardize tasks and easily re-execute them with minimal effort, ensuring consistent results across different environments. | ||
| 3. **Task** is a specific instance of a job or operation executed by Semaphore. It refers to running a predefined action (like an Ansible playbook or a script) using a task template. Tasks can be initiated manually or automatically through schedules and are tracked to give you detailed feedback on the execution, including success, failure, and logs. | ||
| 4. **Schedules** allow you to automate task execution at specified times or intervals. This feature is useful for running periodic maintenance tasks, backups, or deployments without manual intervention. You can configure recurring schedules to ensure important automation tasks are performed regularly and on time. | ||
| 5. **Inventory** is a collection of target hosts (servers, virtual machines, containers, etc.) on which tasks will be executed. The inventory includes details about the managed nodes such as IP addresses, SSH credentials, and grouping information. It allows for dynamic control over which environments and hosts your automation will interact with. | ||
| 6. **Environment** refers to a configuration context that holds sensitive information such as environment variables and secrets used by tasks during execution. It separates sensitive data from task templates and allows you to switch between different setups while running the same task template across different environments securely. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| You can install Semaphore using the following methods: | ||
| * Docker | ||
| * SaaS ([Semaphore Cloud](https://cloud.semaphoreui.com)) | ||
| * Deploy a VM from a marketplace (AWS, DigitalOcean, etc.) | ||
| * Snap | ||
| * Binary file | ||
| * Debian or RPM package | ||
|
|
||
| ### Docker | ||
|
|
||
| [](https://semaphoreui.com/install/docker/) | ||
| The most popular way to install Semaphore is via Docker. | ||
|
|
||
| ``` | ||
| docker run -p 3000:3000 --name semaphore \ | ||
| -e SEMAPHORE_DB_DIALECT=bolt \ | ||
| -e SEMAPHORE_ADMIN=admin \ | ||
| -e SEMAPHORE_ADMIN_PASSWORD=changeme \ | ||
| -e SEMAPHORE_ADMIN_NAME=Admin \ | ||
| -e SEMAPHORE_ADMIN_EMAIL=admin@localhost \ | ||
| -d semaphoreui/semaphore:latest | ||
| ``` | ||
|
|
||
| We recommend using the [Container Configurator](https://semaphoreui.com/install/docker/) to get the ideal Docker configuration for Semaphore. | ||
|
|
||
| ### SaaS | ||
|
|
||
| We offer a SaaS solution for using Semaphore UI without installation. Check it out at [Semaphore Cloud](https://cloud.semaphoreui.com). | ||
|
|
||
| ### Deploy VM from Marketplace | ||
|
|
||
| ### Other installation methods | ||
| [https://semaphoreui.com/install](https://semaphoreui.com/install) | ||
| Supported cloud providers: | ||
| * [Semaphore Run](https://cloud.semaphore.run/servers/new/semaphore) | ||
| * [AWS](https://aws.amazon.com/marketplace/pp/prodview-5noeat2jipwca) | ||
| * [Yandex Cloud](https://yandex.cloud/en-ru/marketplace/products/fastlix/semaphore) | ||
| * DigitalOcean (coming soon) | ||
|
|
||
| ## Demo | ||
| ### Other Installation Methods | ||
|
|
||
| You can test latest version of Semaphore on https://cloud.semaphoreui.com. | ||
| For more installation options, visit our [Installation page](https://semaphoreui.com/install). | ||
|
|
||
| ## Docs | ||
| ## Documentation | ||
|
|
||
| Admin and user docs: https://docs.semaphoreui.com. | ||
| * [User Guide](https://docs.semaphoreui.com) | ||
| * [API Reference](https://semaphoreui.com/api-docs) | ||
|
|
||
| API description: https://semaphoreui.com/api-docs/. | ||
| ## License | ||
| MIT © [Denis Gukov](https://github.com/fiftin) | ||
|
|
||
| [](https://www.patreon.com/semaphoreui) | ||
| [](https://ko-fi.com/fiftin) |