Skip to content

Commit 1731b61

Browse files
committed
feat: intro
1 parent e71edf9 commit 1731b61

File tree

3 files changed

+51
-3
lines changed

3 files changed

+51
-3
lines changed

src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
* [Welcome to Semaphore UI](./README.md)
44

55
* [Admin Guide](./administration-guide/README.md)
6+
<!-- * [Introduction](./administration-guide/introduction.md) -->
67
* [Installation](./administration-guide/installation.md)
78
* [Package manager](./administration-guide/installation/package-manager.md)
89
* [Docker](./administration-guide/installation/docker.md)

src/administration-guide/README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,37 @@
11
# Administration Guide
22

3-
Use this guide to install, configure, secure, operate, and upgrade Semaphore.
3+
Welcome to the Semaphore UI Administration Guide. This guide provides comprehensive information for installing, configuring, and maintaining your Semaphore instance.
44

5-
## Start here
5+
## What is Semaphore UI?
6+
7+
Semaphore UI is a modern, open-source web interface for running automation tasks. It is designed to be a lightweight, fast, and easy-to-use alternative to more complex automation platforms.
8+
9+
It allows you to securely manage and execute tasks for:
10+
* **Ansible** playbooks
11+
* **Terraform/OpenTofu** infrastructure-as-code
12+
* **PowerShell** and **Shell** scripts
13+
* **Python** scripts
14+
15+
## Core Features & Philosophy
16+
17+
Understanding Semaphore's design principles can help you get the most out of it:
18+
19+
* **Lightweight and Performant**: Semaphore is written in **Go** and distributed as a **single binary file**. It has minimal resource requirements (CPU/RAM) and does not require external dependencies like Kubernetes, Docker, or a JVM. This makes it fast, efficient, and easy to deploy.
20+
* **Simple to Install and Maintain**: You can get Semaphore running in minutes. Installation can be as simple as downloading the binary and running it. The simple architecture makes upgrades and maintenance straightforward.
21+
* **Flexible Deployment**: Run it as a binary, as a systemd service, or in a Docker container. It's suitable for everything from a personal homelab to enterprise environments.
22+
* **Self-Hosted and Secure**: Semaphore is a self-hosted solution. All your data, credentials, and logs remain on your own infrastructure, giving you full control. Credentials are always encrypted in the database.
23+
* **Powerful Integrations**: While simple, Semaphore supports powerful features like LDAP/OpenID authentication, detailed role-based access control (RBAC) per project, remote runners for scaling out task execution, and a full REST API for programmatic access.
24+
25+
This guide will walk you through setting up and managing these features for your specific needs.
26+
27+
<!-- ## Start here
628
729
- Installation options: package manager, Docker/Compose, binary, Kubernetes (Helm), Snap (deprecated)
830
- Post-install configuration: config file, environment variables, interactive CLI setup
931
- Security essentials: reverse proxy, TLS, database and network hardening
1032
- Authentication: LDAP and OpenID Connect providers
1133
- Operations: CLI, runners, logs, notifications
12-
- Maintenance: upgrading and troubleshooting
34+
- Maintenance: upgrading and troubleshooting -->
1335

1436
## Quick links
1537

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Introduction
2+
3+
Welcome to the Semaphore UI Administration Guide. This guide provides comprehensive information for installing, configuring, and maintaining your Semaphore instance.
4+
5+
## What is Semaphore UI?
6+
7+
Semaphore UI is a modern, open-source web interface for running automation tasks. It is designed to be a lightweight, fast, and easy-to-use alternative to more complex automation platforms.
8+
9+
It allows you to securely manage and execute tasks for:
10+
* **Ansible** playbooks
11+
* **Terraform/OpenTofu** infrastructure-as-code
12+
* **PowerShell** and **Shell** scripts
13+
* **Python** scripts
14+
15+
## Core Features & Philosophy
16+
17+
Understanding Semaphore's design principles can help you get the most out of it:
18+
19+
* **Lightweight and Performant**: Semaphore is written in **Go** and distributed as a **single binary file**. It has minimal resource requirements (CPU/RAM) and does not require external dependencies like Kubernetes, Docker, or a JVM. This makes it fast, efficient, and easy to deploy.
20+
* **Simple to Install and Maintain**: You can get Semaphore running in minutes. Installation can be as simple as downloading the binary and running it. The simple architecture makes upgrades and maintenance straightforward.
21+
* **Flexible Deployment**: Run it as a binary, as a systemd service, or in a Docker container. It's suitable for everything from a personal homelab to enterprise environments.
22+
* **Self-Hosted and Secure**: Semaphore is a self-hosted solution. All your data, credentials, and logs remain on your own infrastructure, giving you full control. Credentials are always encrypted in the database.
23+
* **Powerful Integrations**: While simple, Semaphore supports powerful features like LDAP/OpenID authentication, detailed role-based access control (RBAC) per project, remote runners for scaling out task execution, and a full REST API for programmatic access.
24+
25+
This guide will walk you through setting up and managing these features for your specific needs.

0 commit comments

Comments
 (0)