👋 Welcome to yourls 🚀

Your Own URL Shortener

📋 Description

Your Own URL Shortener

🚀 Services

• app: yourls:latest

Infrastructure Components

• db: Mariadb database

📦 Installation

Option 1: Quick Install

curl -q -LSsf "https://raw.githubusercontent.com/composemgr/yourls/main/docker-compose.yaml" -o compose.yml

Option 2: Git Clone

git clone "https://github.com/composemgr/yourls" ~/.local/srv/docker/yourls
cd ~/.local/srv/docker/yourls
docker compose up -d

Option 3: Using composemgr

composemgr install yourls

🔧 Configuration

Environment Variables

TZ=America/New_York
APP_ADMIN_USER=administrator
APP_ADMIN_PASS=i3UvaNvrSjwLsgYyonAH4jucBYuRUF82

See docker-compose.yaml for complete list of configurable options.

🌐 Access

• Web Interface: http://172.17.0.1:60321

📂 Volumes

• ./rootfs/data/db/mysql - Data storage

🔐 Security

• Change all default passwords before deploying to production
• Use strong secrets for all authentication tokens
• Configure HTTPS using a reverse proxy (nginx, traefik, caddy)
• Regularly update Docker images for security patches
• Backup your data regularly

🔍 Logging

docker compose logs -f app

🛠️ Management

# Start services
docker compose up -d

# Stop services
docker compose down

# Update to latest images
docker compose pull && docker compose up -d

# View logs
docker compose logs -f

# Restart services
docker compose restart

📋 Requirements

• Docker Engine 20.10+
• Docker Compose V2+

🤝 Author

🤖 casjay: Github 🤖
🦄 composemgr: Github 🦄