Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
41 changes: 41 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

## Installation

```bash
yarn
```

## Local Development

```bash
yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

## Build

```bash
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

Using SSH:

```bash
USE_SSH=true yarn deploy
```

Not using SSH:

```bash
GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
12 changes: 12 additions & 0 deletions docs/blog/2019-05-28-first-blog-post.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
slug: first-blog-post
title: First Blog Post
authors: [slorber, yangshun]
tags: [hola, docusaurus]
---

Lorem ipsum dolor sit amet...

<!-- truncate -->

...consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
44 changes: 44 additions & 0 deletions docs/blog/2019-05-29-long-blog-post.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
slug: long-blog-post
title: Long Blog Post
authors: yangshun
tags: [hello, docusaurus]
---

This is the summary of a very long blog post,

Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.

<!-- truncate -->

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
24 changes: 24 additions & 0 deletions docs/blog/2021-08-01-mdx-blog-post.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
slug: mdx-blog-post
title: MDX Blog Post
authors: [slorber]
tags: [docusaurus]
---

Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).

:::tip

Use the power of React to create interactive blog posts.

:::

{/* truncate */}

For example, use JSX to create an interactive button:

```js
<button onClick={() => alert('button clicked!')}>Click me!</button>
```

<button onClick={() => alert('button clicked!')}>Click me!</button>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions docs/blog/2021-08-26-welcome/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
slug: welcome
title: Welcome
authors: [slorber, yangshun]
tags: [facebook, hello, docusaurus]
---

[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).

Here are a few tips you might find useful.

<!-- truncate -->

Simply add Markdown files (or folders) to the `blog` directory.

Regular blog authors can be added to `authors.yml`.

The blog post date can be extracted from filenames, such as:

- `2019-05-30-welcome.md`
- `2019-05-30-welcome/index.md`

A blog post folder can be convenient to co-locate blog post images:

![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)

The blog supports tags as well!

**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.
25 changes: 25 additions & 0 deletions docs/blog/authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
yangshun:
name: Yangshun Tay
title: Ex-Meta Staff Engineer, Co-founder GreatFrontEnd
url: https://linkedin.com/in/yangshun
image_url: https://github.com/yangshun.png
page: true
socials:
x: yangshunz
linkedin: yangshun
github: yangshun
newsletter: https://www.greatfrontend.com

slorber:
name: Sébastien Lorber
title: Docusaurus maintainer
url: https://sebastienlorber.com
image_url: https://github.com/slorber.png
page:
# customize the url of the author page at /blog/authors/<permalink>
permalink: '/all-sebastien-lorber-articles'
socials:
x: sebastienlorber
linkedin: sebastienlorber
github: slorber
newsletter: https://thisweekinreact.com
19 changes: 19 additions & 0 deletions docs/blog/tags.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
facebook:
label: Facebook
permalink: /facebook
description: Facebook tag description

hello:
label: Hello
permalink: /hello
description: Hello tag description

docusaurus:
label: Docusaurus
permalink: /docusaurus
description: Docusaurus tag description

hola:
label: Hola
permalink: /hola
description: Hola tag description
41 changes: 41 additions & 0 deletions docs/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Welcome to Semaphore UI

## What is Semaphore UI?

Semaphore UI is a modern UI and powerful API for Ansible, Terraform, OpenTofu, PowerShell and other DevOps tools.

<img style="box-shadow: none;" src=".gitbook/assets/134777345-8789d9e4-ff0d-439c-b80e-ddc56b74fcee.webp">

Semaphore is written in pure Go and available for Windows, macOS and Linux (x64, ARM, ARM64). Semaphore is an open-source project with concise and high-quality code.

Semaphore supports the following databases:

* MySQL
* PostgreSQL
* [BoltDB](https://github.com/etcd-io/bbolt) – embedded key/value database

With Semaphore you can:

* [Build, deploy and rollback](./administration-guide/cicd.md)
* Group playbooks to projects
* Manage environments, inventories, repositories and access keys
* Run playbooks from the browser. Responsive UI allows the use of Semaphore on mobile devices
* Run playbooks by schedule
* View detailed logs of any playbook runs, at any time
* Delegate other users the running of playbooks
* Get notifications about playbook runs

## Links

* Source code: [https://github.com/semaphoreui/semaphore](https://github.com/semaphoreui/semaphore)
* Issue tracking: [https://github.com/semaphoreui/semaphore/issues](https://github.com/semaphoreui/semaphore/issues)
* Docker: [https://hub.docker.com/r/semaphoreui/semaphore](https://hub.docker.com/r/semaphoreui/semaphore)
* Snap: [https://snapcraft.io/semaphore](https://snapcraft.io/semaphore)
* Contact: [[email protected]](mailto:[email protected])
* Docker container configurator:

[![](https://img.shields.io/badge/docker_configurator-0050ab?style=for-the-badge&logo=docker)](https://semaphoreui.com/install/docker/)

* Our responsive community:

[![discord](https://img.shields.io/badge/discord_community-510b80?style=for-the-badge&logo=discord)](https://discord.gg/5R6k7hNGcH)
94 changes: 94 additions & 0 deletions docs/docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# Table of contents

* [Welcome to Semaphore UI](./README.md)

* [Admin Guide](./administration-guide/README.md)
<!-- * [Introduction](./administration-guide/introduction.md) -->
* [Installation](./administration-guide/installation.md)
* [Package manager](./administration-guide/installation/package-manager.md)
* [Docker](./administration-guide/installation/docker.md)
* [Cloud](./administration-guide/installation/cloud.md)
* [Binary file](./administration-guide/installation/binary-file.md)
* [Kubernetes (Helm chart)](./administration-guide/installation/k8s.md)
* [Snap (deprecated)](./administration-guide/installation/snap.md)
* [Manual Installation](./administration-guide/installation\_manually.md)
* [Configuration](./administration-guide/configuration.md)
* [Configuration file](./administration-guide/configuration/config-file.md)
* [Environment variables](./administration-guide/configuration/env-vars.md)
* [Interactive setup](./administration-guide/configuration/cli.md)
* [Snap configuration](./administration-guide/configuration/snap.md)
* [Upgrading](./administration-guide/upgrading.md)
* [Security](./administration-guide/security.md)
* [Database security](./administration-guide/security/database.md)
* [Network security](./administration-guide/security/network.md)
* [NGINX config](./administration-guide/security/nginx.md)
* [Apache config](./administration-guide/security/apache.md)
* [Kerberos](./administration-guide/security/kerberos.md)
* [CLI](./administration-guide/cli.md)
* [Users](./administration-guide/cli/users.md)
* [Vaults](./administration-guide/cli/vaults.md)
* [Runners](./administration-guide/cli/runners.md)
* [Database migrations](./administration-guide/cli/migrations.md)
* [LDAP](./administration-guide/ldap.md)
* [OpenID](./administration-guide/openid.md)
* [GitHub config](./administration-guide/openid/github.md)
* [Google config](./administration-guide/openid/google.md)
* [GitLab config](./administration-guide/openid/gitlab.md)
* [Gitea config](./administration-guide/openid/gitea.md)
* [Authelia config](./administration-guide/openid/authelia.md)
* [Authentik config](./administration-guide/openid/authentik.md)
* [Keycloak config](./administration-guide/openid/keycloak.md)
* [Okta config](./administration-guide/openid/okta.md)
* [Azure config](./administration-guide/openid/azure.md)
* [Zitadel config](./administration-guide/openid/zitadel.md)
* [API](./administration-guide/api.md)
* [Pipelines](./administration-guide/cicd.md)
* [Runners](./administration-guide/runners.md)
* [Logs](./administration-guide/logs.md)
* [Notifications](./administration-guide/notifications.md)
* [Email](./administration-guide/notifications/email.md)
* [Telegram](./administration-guide/notifications/telegram.md)
* [Slack](./administration-guide/notifications/slack.md)
* [Teams](./administration-guide/notifications/teams.md)
* [Rocket.Chat](./administration-guide/notifications/rocket.md)
* [DingTalk](./administration-guide/notifications/ding.md)
* [Gotify](./administration-guide/notifications/gotify.md)

* [Troubleshooting](./administration-guide/troubleshooting.md)


* [User Guide](./user-guide/README.md)
* [Projects](./user-guide/projects.md)
* [History](./user-guide/projects/history.md)
* [Activity](./user-guide/projects/activity.md)
* [Settings](./user-guide/projects/settings.md)
* [Runners (Pro)](./user-guide/projects/runners.md)
* [Task Templates](./user-guide/task-templates/README.md)
* [Ansible](./user-guide/task-templates/apps/ansible.md)
* [Terraform/OpenTofu](./user-guide/task-templates/apps/terraform.md)
* [Workspaces](./user-guide/task-templates/apps/terraform/workspaces.md)
* [HTTP Backend (Pro)](./user-guide/task-templates/apps/terraform/states.md)
* [Shell/Bash scripts](./user-guide/task-templates/apps/bash.md)
* [PowerShell](./user-guide/task-templates/apps/powershell.md)
* [Python](./user-guide/task-templates/apps/python.md)
* [Survey Variables](./user-guide/task-templates/survey-vars.md)
* [Tasks](./user-guide/tasks.md)
* [Schedules](./user-guide/schedules.md)
* [Key Store](./user-guide/key-store.md)
* [GitLab](./user-guide/key-store/gitlab.md)
* [Inventory](./user-guide/inventory.md)
* [Kerberos](./user-guide/inventory/kerberos.md)
* [NetBox dynamic inventory](./user-guide/netbox-dynamic-inventory.md)
* [Variable Groups](./user-guide/environment.md)
* [Repositories](./user-guide/repositories.md)
* [Bitbucket Access Token](./user-guide/repositories/bitbucket_access_token.md)
* [Integrations](./user-guide/integrations.md)
* [Team](./user-guide/team.md)
<!-- * [Admin](./user-guide/admin/README.md)
* [Users](./user-guide/admin/users.md)
* [Runners](./user-guide/admin/runners.md)
* [Active Tasks](./user-guide/admin/tasks.md)
* [Subscription 🅿](./user-guide/admin/subscription.md) -->

* [FAQ]()
* [Troubleshooting](./faq/troubleshooting.md)
Loading