Optimized descriptions, README.md's and meta/main.yml's for portfolio and sphinx docs

This commit is contained in:
2025-04-09 00:29:23 +02:00
parent da5962c337
commit 28e25f0232
73 changed files with 1535 additions and 435 deletions

View File

@@ -1 +1,31 @@
# role docker-yourls
# YOURLS URL Shortener
## Description
YOURLS (Your Own URL Shortener) is an opensource URL shortening solution that enables you to create, track, and manage short links with ease. This deployment leverages Docker to provide a secure and easily scalable environment, ensuring that your YOURLS instance is configured for optimal performance and reliability.
## Overview
This containerized YOURLS solution is built on robust Docker Compose and Ansible automation. It simplifies the deployment process by integrating with centralized MariaDB management and providing preconfigured health checks and environment settings. Whether you're looking to quickly generate memorable links or need detailed analytics, this deployment supports your digital strategy seamlessly.
## Features
- **Efficient URL Shortening:**
Quickly generate short, branded links that help streamline your online presence.
- **Built-in Analytics:**
Monitor link performance and track click data to gain valuable insights into user engagement.
- **Centralized Database Integration:**
Seamlessly connect to a MariaDB instance for consistent, reliable data storage and management.
- **Configurable Environment:**
Easily customize your YOURLS instance through environment variables—set your site URL, admin credentials, and more.
- **Secure and Scalable:**
Benefit from container isolation and reproducible deployments that ensure your service is both secure and scalable.
## Further Resources
- [YOURLS Official Website](https://yourls.org/)
- [YOURLS GitHub Repository](https://github.com/YOURLS/YOURLS)

View File

@@ -0,0 +1,28 @@
---
galaxy_info:
author: "Kevin Veen-Birkenbach"
description: >
Streamline your online presence with YOURLS — a nimble, opensource URL shortener that empowers you to create, track, and manage short links effortlessly.
This containerized deployment integrates centralized MariaDB support and a customizable environment, ensuring a secure and scalable solution for all your link management needs.
license: "CyMaIS NonCommercial License (CNCL)"
license_url: "https://s.veen.world/cncl"
company: |
Kevin Veen-Birkenbach
Consulting & Coaching Solutions
https://www.veen.world
min_ansible_version: "2.9"
platforms:
- name: Linux
versions:
- all
galaxy_tags:
- yourls
- url-shortener
- docker
- automation
repository: "https://s.veen.world/cymais"
issue_tracker_url: "https://s.veen.world/cymaisissues"
documentation: "https://s.veen.world/cymais"
logo:
class: "fa-solid fa-link"
dependencies: []