Welcome to Trunk8 Documentation¶

🔗 Modern Link Shortener and File Host¶
Trunk8 is a powerful, self-hosted link shortener and file hosting platform built with Flask. Transform long URLs into memorable short codes, host files with secure downloads, and create beautiful markdown documents with live rendering.
Key Features¶
- 👥 Multi-User Support - Individual user accounts with isolated data and admin management
- 🔗 Smart Link Shortening - Convert any URL into clean, memorable short codes
- 📁 Secure File Hosting - Upload and share files with UUID4 security, metadata tracking, and original filename preservation
- 📝 Live Markdown Rendering - Create and share markdown documents with real-time rendering using StrapDown.js
- 💻 Raw HTML Hosting - Host custom web pages with full CSS, JavaScript, and interactive elements
- 🎨 Customizable Themes - Choose from 25+ Bootswatch themes for both UI and markdown
- 🔐 Advanced Authentication - Multi-user login system with admin privileges and user switching
- ⚡ Live Configuration - TOML-based config with automatic reloading
- 🐳 Docker Ready - One-command deployment with optimized Astral uv image
- ⏱️ Link Expiration - Set expiration dates for temporary links with automatic cleanup
Quick Navigation¶
-
🚀 Getting Started
Install Trunk8 and create your first shortened link in minutes
-
📖 User Guide
Learn how to use all of Trunk8's features effectively
-
⚙️ Configuration
Customize Trunk8 to fit your needs with TOML configuration
-
{}Development
Contribute to Trunk8 or extend it for your use case
Why Trunk8?¶
Privacy First¶
Host your own link shortener and file host, keeping full control over your data without relying on third-party services.
Modern Architecture¶
Built with Flask and modern Python practices, featuring a modular blueprint architecture that's easy to understand and extend.
Feature Rich¶
Supports multiple link types (URLs, files, markdown), automatic expiration, theme customization, and secure authentication out of the box.
Easy Deployment¶
Deploy with Docker in minutes using our optimized container image, or run directly with Python using uv for fast dependency management.
Example Use Cases¶
- Personal Link Management - Shorten and organize your frequently shared links with your own account
- Team Collaboration - Deploy internally with individual user accounts for each team member
- Client Management - Provide individual accounts for clients with isolated data access
- Organization File Sharing - Securely host and share files with isolated user storage
- Documentation Hosting - Create and share markdown documents with user-specific content
- API Integration - Build custom integrations with per-user API access patterns
Getting Help¶
- 📖 User Guide - Comprehensive guide to using Trunk8
- 🔧 Configuration Reference - Detailed configuration options
- 🐛 GitHub Issues - Report bugs or request features
- 💬 Discussions - Ask questions and share ideas
License¶
Trunk8 is open source software licensed under the MIT License. # Manual trigger test