oxl-ansible-webui 0.9.4.post2

Basic WebUI for using Ansible

Simple WebUI for using Ansible

---

DISCLAIMER: This is an unofficial community project! Do not confuse it with the vanilla Ansible product!

The goal is to allow users to quickly install & run a WebUI for using Ansible locally.

Keep it simple.

---

Setup

Local - PIP

Requires Python >=3.10

# install
python3 -m pip install oxl-ansible-webui

# run
oxl-ansible-webui

Docker

Images: ansible-webui, ansible-webui-unprivileged, ansible-webui-mysql, ansible-webui-psql, ansible-webui-aws

We build the image for alpine and debian.

docker image pull oxlorg/ansible-webui:latest
docker run -d --name ansible-webui --publish 127.0.0.1:8000:8000 oxlorg/ansible-webui:latest

# or with persistent data (volumes: /data = storage for logs & DB, /play = ansible playbook base-directory)
docker run -d --name ansible-webui --publish 127.0.0.1:8000:8000 --volume $(pwd)/ansible/data:/data --volume $(pwd)/ansible/play:/play oxlorg/ansible-webui:latest

Optional Dependencies

pip install oxl-ansible-webui[mysql]
pip install oxl-ansible-webui[psql]
pip install oxl-ansible-webui[ara]
pip install oxl-ansible-webui[saml]

---

Demo

Check out the demo at: demo.ansible-webui.OXL.app

Login: User demo, Password Ansible1337

---

Usage

Documentation

See also: oxl-ansible-executor

---

Contribute

Feel free to contribute to this project using pull-requests, issues and discussions!

What we need:

• Testers and feedback
• More Test-cases
• Translations for your language(s)

See also: Contributing

---

Roadmap

V1.0

• Refactor WebUI => SvelteJS & TailwindCSS
• Data-update over Websockets
• Django 5.1

Full

• Ansible Config

  • Static Playbook-Directory

  • Git Repository support

• Users

  • Management interface (Django built-in)

  • Groups & Job Permissions

  • LDAP integration

  • SAML SSO integration

• Jobs

  • Execute Ansible using ansible-runner

    • Scheduled execution (Cron-Format)

    • Manual/immediate execution

    • Custom Execution-Forms

    • Support for ad-hoc commands

    • Support for Process-Isolation

  • Job Logging

    • Write job metadata to database

    • Write full job-logs to Filesystem

  • Secret handling (Connect, Become, Vault)

    • User-specific job credentials

  • Alerting on Failure

    • E-Mail

    • Support for external Plugins (simple Interface for Scripts)

• WebUI

  • Job Dashboard

    Status, Execute, Time of last & next execution, Last run User, Links to Warnings/Errors

  • Job Output

    Follow the jobs output in realtime

  • Job Errors

    UI that allows for easy error analysis. Access to logs and provide links to possible solutions

  • Show Ansible Running-Config

  • Show Ansible Collections

    • Check Collections for available updates (Galaxy + GitHub releases)

  • Mobile Support

  • Multi-Language Support

• API

  • Manage and execute Jobs

• Database

  • Support for MySQL

• Testing

  • Unit Tests

  • Integration Tests

    • WebUI checks

    • API Endpoints

    • Job Execution

    • Permission system

---

License

GPLv3

For dependencies see: attributions