YOURLS¶

YOURLS Key Features¶

• Full control over links: use your own domain or subdomain for short URLs, ensuring brand recognition;
• Detailed statistics and analytics: tracking the number of clicks, traffic sources, visitor geography, and other metrics for each short link;
• Custom keywords: the ability to set your own descriptive and memorable keywords for short links;
• Public and private links: creating open short URLs for wide distribution or private links with restricted access;
• Bookmarklets: quickly shortening links directly from your browser without needing to visit the YOURLS website;
• Developer API: a simple API for programmatic access, allowing you to integrate YOURLS with other applications and automate tasks;
• Plugin architecture: extending functionality by installing plugins available in the YOURLS ecosystem;
• Sequential or custom URL creation: the ability to generate sequential short URLs or use custom configurations;
• Secure user management: protected access to the administration interface using password hashing.

Deployment Features¶

Getting Started After YOURLS Deployment¶

After payment is completed, a notification regarding server readiness will be sent to the email address provided during registration. It will contain the VPS IP address, as well as the login and password for connection. Clients can manage their hardware through the server management panel and API — Invapi.

Authorization credentials can be found in the Configuration >> Tags tab of the server management panel or in the sent email:

• Link to access the YOURLS web interface: located in the webpanel tag;
• Username and Password for server management: sent via email once the server is delivered.

Logging into the Administration Panel¶

To access the YOURLS interface, follow these steps:

1. Open a web browser and go to the link: https://yourls{Server_ID}.hostkey.in.

2. Upon your first visit, you will be directed to the login page. Enter your credentials:

   • Username: root
   • Password: the default password specified in the server readiness notification;

3. Click Login.

Creating Short Links¶

After successfully logging into the administration panel, you will be directed to the home page where you can create new short links:

1. In the Enter the URL here field, enter the full URL address that needs to be shortened;

2. In the Optional custom keyword field (optional), set a custom keyword for the short link. If you leave this field empty, the keyword will be generated automatically;

3. Click Shorten The URL to create the short link;

4. The result will be displayed on the page:

   • Short URL - the ready-to-use short link;
   • Your link - the full version of the short link for copying;
   • Copy - a button for quick copying to the clipboard.

Statistics and Analytics¶

YOURLS provides detailed statistics for all created short links:

1. Go to the Statistics section in the top menu;

2. The statistics page displays:

   • total number of clicks per link;
   • a list of redirects including date and time;
   • traffic sources (referrer);
   • User-Agents;
   • visitor geographic data;

3. To view detailed statistics for a specific link, click on its ID in the table;

4. Statistics allow you to:

   • track link popularity;
   • analyze the effectiveness of marketing campaigns;
   • optimize traffic distribution.

Bookmarklets¶

Bookmarklets are special browser bookmarks that allow you to shorten links with a single click without visiting the YOURLS website:

1. Go to the Bookmarklets section in the YOURLS top menu;

2. Drag and drop the desired icon onto your browser's bookmarks bar:

   • Shorten - an icon for shortening the current page;
   • Shorten with custom keyword - an icon that allows you to specify a keyword;
   • Share - an icon for quickly sharing a shortened link;

3. While viewing an interesting page, click the corresponding icon on your bookmarks bar;

4. A dialog box will appear with the result — the ready short link.

YOURLS Plugins¶

YOURLS supports extending functionality through a plugin system:

1. Go to the Plugins section in the administration panel;

2. The list of installed plugins is displayed on the page. To enable or disable a plugin, use the toggle switch next to its name;

3. To install a new plugin:

   • download the plugin from the official YOURLS repository;
   • extract the archive into the user/plugins/ directory;
   • the plugin will appear in the list of available plugins in the administration panel;
   • activate the plugin by clicking the corresponding button;

4. Popular plugins include:

   • GeoIP - identification of visitor geographic location;
   • Click counter - advanced click counting;
   • Social Sharing - integration with social networks;
   • Password Protection - protecting links with a password;
   • Expiry - automatic expiration of links.

Ordering a Server with YOURLS via API¶

To install this software using the API, follow these instructions.