Deploy

Documentation

Complete documentation for the URL Shortener project.

Welcome to the URL Shortener documentation. Choose a topic to get started.

Product Positioning

URLShortener is a European URL shortening and URL management solution from Germany. The base version is open source and designed for on-premises operation. It gives organizations full control over where their links, data, and infrastructure are hosted.

Getting Started

Build and run the URL Shortener in minutes.

Architecture

How the URL Shortener is structured — modules, data flow, and design decisions.

API Reference

Complete REST API documentation for the URL Shortener admin and redirect endpoints.

Configuration

System properties, ports, storage modes, and tuning options.

Enterprise Plug-ins

Install and license the commercial plug-in layer: classpath deployment for the REST server and the Vaadin UI, the license file, and how to verify the result.