Skip to main content

Basic WebUI for using Ansible

Project description

Basic WebUI for using Ansible

Buy me a coffee

Documentation Lint Test

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.

This project is still in early development! DO NOT USE IN PRODUCTION!


Setup

Local - PIP

Requires Python >=3.10

# install
python3 -m pip install ansibleguy-webui

# run
python3 -m ansibleguy-webui

Docker

Images: webui, webui-unprivileged, webui-aws

docker image pull ansible0guy/webui:latest
docker run -d --name ansible-webui --publish 127.0.0.1:8000:8000 ansible0guy/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 ansible0guy/webui:latest

Demo

Check out the demo at: demo.webui.ansibleguy.net

Login: User demo, Password Ansible1337


Usage

Documentation


Contribute

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

Testers are also very welcome! Please give feedback

See also: Contributing


Roadmap

  • Ansible Config

    • Static Playbook-Directory

    • Git Repository support

  • Users

  • Jobs

    • Execute Ansible using ansible-runner

    • 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

      • Basic WebUI checks

      • API Endpoints

      • Permission system

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ansibleguy_webui-0.0.19.tar.gz (145.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ansibleguy_webui-0.0.19-py3-none-any.whl (189.1 kB view details)

Uploaded Python 3

File details

Details for the file ansibleguy_webui-0.0.19.tar.gz.

File metadata

  • Download URL: ansibleguy_webui-0.0.19.tar.gz
  • Upload date:
  • Size: 145.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for ansibleguy_webui-0.0.19.tar.gz
Algorithm Hash digest
SHA256 4ec8d6158cbd4e7cdfebe4bf31afd7f76cdeb1da135331be654af81c7cf93c34
MD5 4a74a67c7fb163479d18e250ef9c9de2
BLAKE2b-256 b8dd59944aa74527d665694867b593f337750815e3d7de7d98e751ae3ffd2ab6

See more details on using hashes here.

File details

Details for the file ansibleguy_webui-0.0.19-py3-none-any.whl.

File metadata

File hashes

Hashes for ansibleguy_webui-0.0.19-py3-none-any.whl
Algorithm Hash digest
SHA256 6b00115d4081f20118788857c886d782e5db6f2a6446d3a5f15e7f4eba3e9528
MD5 989b6b33076a66f6bf47a5d5be87152b
BLAKE2b-256 f28dfb5651b7a90f8cf769d595d2551ff0267878cb23a21d47a087c084fdaccd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page