What is Polr?
Polr is a minimalist, open-source, self-hosted URL shortening platform designed to create, manage, and track shortened links.
It allows individuals and organizations to transform long URLs into short, memorable addresses using their own domains. Its clean web interface provides tools for managing links, customizing short URLs, controlling user permissions, and monitoring link activity.
Polr also provides a REST API that allows external applications, scripts, and automated workflows to create and retrieve shortened URLs programmatically.
Unlike commercial URL shortening services, Polr can operate on privately managed infrastructure, giving administrators control over their domains, data, users, and link management policies.
Its lightweight architecture and customizable interface make it suitable for businesses, developers, marketing teams, and organizations looking for an independent URL shortening solution.
History of Polr
Polr is an open-source project originally developed by Chaoyi Zha (cydrobolt).
The project was created to provide a modern, lightweight alternative to commercial URL shortening services, with an emphasis on self-hosting, branding, and developer integrations.
Polr uses PHP and the Lumen framework, with a Laravel-based application architecture and Blade templating.
The platform introduced a REST API, user management, custom URL endings, secret links, and configurable shortening permissions.
Polr is distributed under the GNU General Public License version 2 or later (GPL-2.0+).
Key Features of Polr
Polr provides a focused set of features for creating and managing shortened URLs.
- URL Shortening: Convert long URLs into short, memorable addresses.
- Custom Domains: Host shortened links using your own domain.
- Custom URL Endings: Create personalized short links with recognizable identifiers.
- Link Analytics: Monitor click counts and review available link statistics.
- Secret Links: Generate private shortened URLs that require an additional access key.
- User Management: Manage user accounts and their shortening permissions.
- REST API: Create and retrieve shortened URLs programmatically.
- Bulk URL Shortening: Generate multiple shortened links through a single API request.
- API Key Management: Generate, revoke, and manage API keys for individual users.
- API Rate Limiting: Configure request quotas for API users.
- Link Lookup: Retrieve the destination URL and available information about shortened links.
- Custom Themes: Customize the appearance of the application.
- Branding: Adapt the interface and shortened URL domain to match your organization.
- Access Control: Configure who can create shortened URLs.
- Redirect Management: Customize URL shortening and redirect behavior.
- User Quotas: Control API usage and shortening access.
- Database Flexibility: Support MySQL, MariaDB, and SQLite.
- Self-Hosted Architecture: Maintain control over your links and application data.
Use Cases
Polr is suitable for individuals, developers, and organizations that need a centralized URL shortening service.
Common use cases include:
- Marketing Campaigns: Generate branded links for advertisements, newsletters, and promotional campaigns.
- Social Media: Create short URLs for sharing content across social networks.
- Business Communication: Distribute concise links through emails, documents, and customer communications.
- Developer Integrations: Generate shortened URLs through the REST API.
- Internal Applications: Provide a centralized shortening service for company employees.
- Affiliate Marketing: Organize and distribute promotional links.
- Content Publishing: Create memorable URLs for articles, resources, and downloadable content.
- Application Automation: Automatically shorten URLs generated by external services.
- Branded Link Management: Maintain consistent URL branding across marketing channels.
- Private Link Sharing: Generate secret shortened URLs for restricted sharing scenarios.
Benefits of Polr
- Open-source and self-hosted URL shortening
- Custom domains and branded links
- Clean and lightweight management interface
- Custom short URL identifiers
- Secret URL functionality
- Basic click statistics
- REST API for application integrations
- Bulk URL shortening
- Individual API keys and usage quotas
- Configurable user permissions
- Customizable themes and appearance
- Multiple database options
- No mandatory third-party shortening service
- Greater control over link management and data
How to Install Polr
To install Polr through Esadax, follow these steps:
- Purchase the application through Esadax.
- After purchasing, provide the requested application configuration details.
- Configure the public domain used for shortened URLs.
- Configure the database connection.
- Complete the initial application setup.
- Create the administrator account.
- Access the Polr administration interface.
- Configure user registration and shortening permissions.
- Customize the application branding and appearance.
- Generate API keys for users and integrations.
- Create your first shortened URL.
- Test the generated link and verify that redirection works correctly.
Once configured, Polr provides a centralized platform for creating, managing, and distributing shortened URLs.
URL Shortening and Link Management
Polr provides a simple interface for converting long URLs into short addresses.
Users can submit destination URLs and allow the application to generate unique short identifiers.
For example:
Original URL:
https://www.example.com/products/category/special-product
Shortened URL:
https://go.example.com/a8K2p
Users can also specify custom URL endings when creating links.
For example:
https://go.example.com/summer-sale
Link management capabilities include:
- Creating shortened URLs
- Assigning custom URL endings
- Viewing existing links
- Looking up destination URLs
- Managing secret links
- Reviewing click counts
- Managing links through authorized accounts
This makes Polr suitable for maintaining a centralized collection of branded and trackable URLs.
Custom Domains and Branding
One of Polr's main advantages is its support for custom domains.
Instead of distributing links through a generic shortening service, organizations can operate Polr using their own domain or subdomain.
For example:
https://go.example.comhttps://links.example.comhttps://short.example.com
Using a dedicated domain provides consistent branding and makes shortened URLs easier to recognize.
Polr also supports customization of its interface, allowing administrators to adapt the appearance of the service to their organization's identity.
Customization options include:
- Application name and branding
- Custom domain
- Interface theme
- Visual styling
- Application appearance
- Shortening permissions
- Redirect behavior
A branded shortening domain is particularly useful for marketing campaigns, customer communication, and business applications.
Custom URL Endings
Polr allows users to create personalized short URL identifiers rather than relying exclusively on randomly generated values.
For example:
https://go.example.com/documentation
https://go.example.com/contact
https://go.example.com/product-launch
Custom endings make links easier to recognize and remember.
They are particularly useful for campaigns, printed materials, QR codes, and frequently shared resources.
Polr checks the requested identifier against existing links to prevent conflicting URL endings.
Analytics and Click Tracking
Polr provides basic statistics for monitoring the activity associated with shortened URLs.
The application tracks clicks and makes available link information through its management interface and API.
Available information includes:
- Original destination URL
- Shortened URL identifier
- Link creation date
- Total click count
- Secret-link status
- Link lookup information
The API can retrieve click counts for existing shortened links, allowing external applications to incorporate link activity into custom reporting systems.
These statistics are useful for evaluating the popularity of shared URLs and understanding basic link engagement.
Polr should be considered a lightweight link tracking solution rather than a full marketing analytics platform. Advanced visitor profiling, campaign attribution, and detailed geographic reporting require additional integrations.
Secret Links and Private Sharing
Polr supports secret shortened URLs for situations where a link should not be accessible through its ordinary public address alone.
Secret links use an additional key associated with the shortened URL.
This functionality can be useful when distributing links that should not be easily discovered or accessed by someone who only knows the ordinary shortened address.
Typical use cases include:
- Sharing internal documentation
- Distributing private resources
- Temporary link distribution
- Sharing restricted destination URLs
Secret links should not be considered a replacement for proper authentication or authorization.
Anyone who obtains the complete secret URL may be able to access the destination.
REST API and Developer Integrations
Polr provides a REST API that allows external applications to interact with the shortening service.
The API supports creating shortened URLs, looking up existing links, and performing bulk shortening operations.
API endpoints use the following base path:
/api/v2/
The main operations include:
shorten- Create a shortened URL.shorten_bulk- Shorten multiple URLs in one request.lookup- Retrieve the destination and information associated with a shortened URL.
Example API request:
curl -X POST \
--data-urlencode "url=https://www.example.com/products" \
"https://go.example.com/api/v2/action/shorten?key=YOUR_API_KEY"
A successful response can return a shortened URL:
{
"action": "shorten",
"result": "https://go.example.com/a8K2p"
}
API capabilities are useful for:
- Integrating URL shortening into web applications.
- Automatically shortening URLs generated by backend services.
- Creating links from scripts and automation systems.
- Building custom administration interfaces.
- Generating marketing links programmatically.
- Retrieving destination URLs.
- Monitoring available click statistics.
User Management and API Permissions
Polr provides user management functionality for installations where multiple people or applications need access to the shortening service.
Administrators can manage user accounts and assign API credentials.
Each user can have an individual API key that allows external applications to authenticate when making API requests.
API management includes:
- Creating API keys
- Resetting existing API keys
- Revoking API access
- Enabling or disabling API access
- Configuring API request quotas
- Managing user shortening permissions
API quotas are defined as requests per minute.
This allows administrators to restrict API consumption and prevent individual users or integrations from generating excessive traffic.
The user management functionality is particularly useful when Polr operates as an internal service shared by multiple departments.
Security / Administration / Configuration
Polr provides administrative tools for managing users, links, permissions, and application settings.
Because URL shortening services can be abused to distribute phishing links or conceal malicious destinations, appropriate security controls are important.
Recommended practices include:
- Use strong administrator credentials.
- Enable HTTPS for all application access.
- Restrict administrative access to authorized users.
- Disable public registration when it is not required.
- Configure API quotas for individual users.
- Protect API credentials.
- Review suspicious shortened URLs.
- Monitor link creation activity.
- Restrict access to the administration interface.
- Keep the application and its dependencies updated.
- Back up the database regularly.
- Configure a custom domain with valid TLS certificates.
- Establish procedures for reporting and removing abusive links.
Polr also allows administrators to customize shortening permissions and control how users interact with the application.
Best Practices for Polr
- Use a dedicated domain for shortened URLs.
- Choose recognizable custom URL endings.
- Use branded links for marketing campaigns.
- Generate separate API keys for different integrations.
- Set reasonable API request quotas.
- Protect API keys from unauthorized access.
- Use HTTPS for all public links.
- Review suspicious links and user activity.
- Disable registration if the service is private.
- Avoid using secret links as a substitute for authentication.
- Monitor click counts for important campaigns.
- Back up application data regularly.
- Keep the PHP application and dependencies updated.
- Verify the destination of links before distributing them.
Configuration and Administration
After purchasing this application on Esadax, you will be prompted to provide the configuration details required by the deployment.
Polr provides an interactive setup interface that guides administrators through the initial configuration.
The main configuration areas include:
| Setting | Description |
|---|---|
| Application URL | Public address used to generate shortened links. |
| Site Name | Name displayed throughout the application interface. |
| Database Type | Database backend used for application information. |
| Database Host | Address of the database server. |
| Database Name | Database used to store links and user information. |
| Database Username | Account used by Polr to connect to the database. |
| Database Password | Password associated with the database account. |
| Administrator Username | Initial administrator login name. |
| Administrator Email | Email address associated with the administrator account. |
| Administrator Password | Password used to access the administration interface. |
Once the initial setup is complete, administrators can manage additional settings through the Polr interface.
These include:
- User registration settings
- URL shortening permissions
- Custom branding
- API credentials
- API request quotas
- Link redirect behavior
- Secret URL functionality
- User access policies
Database and Storage
Polr uses a relational database to store application information.
Supported database backends include:
- MySQL
- MariaDB
- SQLite
MySQL or MariaDB is recommended for production environments, while SQLite is available for simpler installations.
The database stores information such as:
- User accounts
- API keys
- Shortened URLs
- Original destination URLs
- Custom URL endings
- Click counters
- Link creation timestamps
- User permissions
- Application settings
Regular database backups are important to preserve shortened URLs and their associated information.
If the database is lost, existing short links may stop functioning even if the domain and application files remain available.
Performance and Scalability
Polr is designed as a lightweight URL shortening application.
Its performance depends primarily on database efficiency, web server configuration, redirect traffic, and the number of managed links.
For larger installations, administrators can improve performance through:
- Efficient database indexing
- Appropriate database resource allocation
- Optimized PHP execution
- Reverse proxy caching for suitable public assets
- Monitoring application response times
- Regular database maintenance
- Appropriate rate limits for API users
Short URL redirects should remain lightweight because they are executed whenever users follow generated links.
For high-traffic services, monitor database performance and application response times as redirect volumes increase.
Conclusion
Polr is a minimalist, open-source URL shortening platform designed to provide control over branded links and link management.
With custom domains, personalized URL endings, basic click statistics, secret links, user permissions, and a REST API, it provides the essential functionality required to operate an independent URL shortening service.
Its lightweight architecture and customizable interface make it suitable for businesses, developers, marketing teams, and organizations that want to manage shortened links without relying on centralized commercial services.
Polr is a practical solution for building a branded URL shortening platform with programmatic integration and centralized administration.

