Portainer Templates logo

Portainer Templates

Ansible-semaphore Ansible-semaphore

Stack

Devops

Modern UI for Ansible

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by xneo1·Source

Services

mysql

Configuration

Image
mysql:8.0
Ports
3306:3306
Volumes
/var/lib/mysql : semaphore-mysql
Env vars
MYSQL_RANDOM_ROOT_PASSWORD=yesMYSQL_DATABASE=semaphoreMYSQL_USER=semaphoreMYSQL_PASSWORD=semaphore
Restart
unless-stopped

Image details

Pulls: 5.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 19 days ago
Status: active

semaphore

Configuration

Image
semaphoreui/semaphore:latest
Ports
3000:3000
Env vars
SEMAPHORE_DB_USER=semaphoreSEMAPHORE_DB_PASS=semaphoreSEMAPHORE_DB_HOST=mysqlSEMAPHORE_DB_PORT=3306SEMAPHORE_DB_DIALECT=mysqlSEMAPHORE_DB=semaphoreSEMAPHORE_PLAYBOOK_PATH=/tmp/semaphore/SEMAPHORE_ADMIN_PASSWORD=changemeSEMAPHORE_ADMIN_NAME=adminSEMAPHORE_ADMIN_EMAIL=admin@localhostSEMAPHORE_ADMIN=adminSEMAPHORE_ACCESS_KEY_ENCRYPTION=gs72mPntFATGJs9qK0pQ0rKtfidlexiMjYCH9gWKhTU=SEMAPHORE_LDAP_ACTIVATED=noSEMAPHORE_LDAP_HOST=dc01.local.example.comSEMAPHORE_LDAP_PORT=636SEMAPHORE_LDAP_NEEDTLS=yesSEMAPHORE_LDAP_DN_BIND=uid=bind_user,cn=users,cn=accounts,dc=local,dc=shiftsystems,dc=netSEMAPHORE_LDAP_PASSWORD=ldap_bind_account_passwordSEMAPHORE_LDAP_DN_SEARCH=dc=local,dc=example,dc=comSEMAPHORE_LDAP_SEARCH_FILTER=(&(uid=%s)(memberOf=cn=ipausers,cn=groups,cn=accounts,dc=local,dc=example,dc=com))
Restart
unless-stopped

Image details

Pulls: 6.7M
User: semaphoreui
Created: Jan 27, 2022
Updated: 10 days ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Ansible-semaphore

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Ansible-semaphore, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  # uncomment this section and comment out the mysql section to use postgres instead of mysql
  #postgres:
    #restart: unless-stopped
    #ports:
      #- 5432:5432
    #image: postgres:14
    #hostname: postgres
    #volumes: 
    #  - semaphore-postgres:/var/lib/postgresql/data
    #environment:
    #  POSTGRES_USER: semaphore
    #  POSTGRES_PASSWORD: semaphore
    #  POSTGRES_DB: semaphore
  # if you wish to use postgres, comment the mysql service section below 
  mysql:
    restart: unless-stopped
    ports:
      - 3306:3306
    image: mysql:8.0
    hostname: mysql
    volumes:
      - semaphore-mysql:/var/lib/mysql
    environment:
      MYSQL_RANDOM_ROOT_PASSWORD: 'yes'
      MYSQL_DATABASE: semaphore
      MYSQL_USER: semaphore
      MYSQL_PASSWORD: semaphore
  semaphore:
    restart: unless-stopped
    ports:
      - 3000:3000
    image: semaphoreui/semaphore:latest
    environment:
      SEMAPHORE_DB_USER: semaphore
      SEMAPHORE_DB_PASS: semaphore
      SEMAPHORE_DB_HOST: mysql # for postgres, change to: postgres
      SEMAPHORE_DB_PORT: 3306 # change to 5432 for postgres
      SEMAPHORE_DB_DIALECT: mysql
      SEMAPHORE_DB: semaphore
      SEMAPHORE_PLAYBOOK_PATH: /tmp/semaphore/
      SEMAPHORE_ADMIN_PASSWORD: changeme
      SEMAPHORE_ADMIN_NAME: admin
      SEMAPHORE_ADMIN_EMAIL: admin@localhost
      SEMAPHORE_ADMIN: admin
      SEMAPHORE_ACCESS_KEY_ENCRYPTION: gs72mPntFATGJs9qK0pQ0rKtfidlexiMjYCH9gWKhTU=
      SEMAPHORE_LDAP_ACTIVATED: 'no' # if you wish to use ldap, set to: 'yes' 
      SEMAPHORE_LDAP_HOST: dc01.local.example.com
      SEMAPHORE_LDAP_PORT: '636'
      SEMAPHORE_LDAP_NEEDTLS: 'yes'
      SEMAPHORE_LDAP_DN_BIND: 'uid=bind_user,cn=users,cn=accounts,dc=local,dc=shiftsystems,dc=net'
      SEMAPHORE_LDAP_PASSWORD: 'ldap_bind_account_password'
      SEMAPHORE_LDAP_DN_SEARCH: 'dc=local,dc=example,dc=com'
      SEMAPHORE_LDAP_SEARCH_FILTER: "(\u0026(uid=%s)(memberOf=cn=ipausers,cn=groups,cn=accounts,dc=local,dc=example,dc=com))"
    depends_on:
      - mysql # for postgres, change to: postgres
volumes:
  semaphore-mysql: # to use postgres, switch to: semaphore-postgres

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/ansible-semaphore.yml up -d

More install options in our documentation.

Container Documentation

mysql Documentation

MySQL is a widely used, open-source relational database management system (RDBMS).

semaphore Documentation

Modern UI and powerful API for Ansible, Terraform, OpenTofu and other popular DevOps tools.

Serve Ansible-semaphore on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying ansible-semaphore.example.com to http://semaphore:3000

Add this to your Caddyfile

ansible-semaphore.example.com {
	reverse_proxy http://semaphore:3000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:3306 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :3306
  • Stop the other service, or pick a different host port. In 3306:3306 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:3000. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, ansible-semaphore can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 3000

Image won't pull

Test the pull directly on the host: docker pull mysql:8.0

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Ansible-semaphore is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • mysql runs mysql:8.0
  • semaphore runs semaphoreui/semaphore:latest, starts after mysql

Ports

A port is the door the app answers on. A mapping like 3306:3306 means it's reachable on port 3306 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:3000 in a browser. It opens:

  • 3306:3306
  • 3000:3000, likely the web interface

Volumes

A volume is where Ansible-semaphore keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/lib/mysql kept in the semaphore-mysql volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Ansible-semaphore takes 24 of them, all with defaults you can leave alone or tweak:

  • MYSQL_RANDOM_ROOT_PASSWORD, defaults to yes
  • MYSQL_DATABASE, defaults to semaphore
  • MYSQL_USER, defaults to semaphore
  • MYSQL_PASSWORD, defaults to semaphore
  • SEMAPHORE_DB_USER, defaults to semaphore
  • SEMAPHORE_DB_PASS, defaults to semaphore
  • SEMAPHORE_DB_HOST, defaults to mysql
  • SEMAPHORE_DB_PORT, defaults to 3306
  • SEMAPHORE_DB_DIALECT, defaults to mysql
  • SEMAPHORE_DB, defaults to semaphore
  • SEMAPHORE_PLAYBOOK_PATH, defaults to /tmp/semaphore/
  • SEMAPHORE_ADMIN_PASSWORD, defaults to changeme
  • SEMAPHORE_ADMIN_NAME, defaults to admin
  • SEMAPHORE_ADMIN_EMAIL, defaults to admin@localhost
  • SEMAPHORE_ADMIN, defaults to admin
  • SEMAPHORE_ACCESS_KEY_ENCRYPTION, defaults to gs72mPntFATGJs9qK0pQ0rKtfidlexiMjYCH9gWKhTU=
  • SEMAPHORE_LDAP_ACTIVATED, defaults to no
  • SEMAPHORE_LDAP_HOST, defaults to dc01.local.example.com
  • SEMAPHORE_LDAP_PORT, defaults to 636
  • SEMAPHORE_LDAP_NEEDTLS, defaults to yes
  • SEMAPHORE_LDAP_DN_BIND, defaults to uid=bind_user,cn=users,cn=accounts,dc=local,dc=shiftsystems,dc=net
  • SEMAPHORE_LDAP_PASSWORD, defaults to ldap_bind_account_password
  • SEMAPHORE_LDAP_DN_SEARCH, defaults to dc=local,dc=example,dc=com
  • SEMAPHORE_LDAP_SEARCH_FILTER, defaults to (&(uid=%s)(memberOf=cn=ipausers,cn=groups,cn=accounts,dc=local,dc=example,dc=com))

Restart policy

The restart policy here is unless-stopped, so Docker restarts Ansible-semaphore after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like mysql) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Ansible-semaphore up. Add the template list to Portainer once, then deploying Ansible-semaphore is a click rather than a wall of config.