Skip to content
Get packs

Guide · Open source

How to use YOURLS: install, run your own short links

Updated · written with AI from the project's own documentation and checked against our catalogue data

YOURLS is a set of PHP scripts that lets you run your own URL shortener on a server you control. This guide explains what it is, who it suits, how to get the code, and where to find the documentation for setup and daily use. By the end you will know what you need before you start and what the project provides.

YOURLSYOURLS/YOURLS · ★ 12.3k · MIT

Quick start

  1. 1Check your server. Confirm you have PHP and a web server available. Check the documentation for current requirements.
  2. 2Clone the repository. Run the git clone command for https://github.com/YOURLS/YOURLS.git to download the code.
  3. 3Read the documentation. Open docs.yourls.org and follow its setup instructions for your environment.
  4. 4Configure your domain. Set up the short domain you want to use on your own server, as the documentation describes.
  5. 5Add plugins if needed. Look through the Awesome YOURLS list for community plugins that extend the base install.

What YOURLS is and who it is for

YOURLS stands for Your Own URL Shortener. The project describes itself as a set of PHP scripts that run on your own server, so the links you create live on a domain you control and the link data stays with you.

It fits people who want short links on their own domain, site owners who want to keep link data on their own server, and developers comfortable running PHP software who want to extend it with plugins. It is not a fit if you want zero setup and no server to manage, or if you need a hosted service with paid support, since the README describes neither.

What you need before installing YOURLS

YOURLS needs PHP and a web server. The README excerpt does not state exact version numbers, so check the official documentation at docs.yourls.org for the current requirements before you begin.

  • PHP
  • A web server
  • Your own server or hosting account where you can run PHP software

Get the YOURLS code

The README gives a clone command to download the repository from GitHub. Run it in the directory where you want the files to live. Installation and configuration steps are covered in the full documentation linked from the project.

git clone https://github.com/YOURLS/YOURLS.git

Using your own domain, stats and plugins

The project says YOURLS gives you detailed stats, analytics, and plugin support. Because it runs on your server, the data is yours to keep. Community-made plugins, tools and guides are collected in the Awesome YOURLS list on GitHub.

For help, the README points to community discussions on GitHub and the official blog. Before opening an issue, search existing issues, open and closed, and read the Contributing Guidelines.

  • Full documentation: docs.yourls.org
  • Community plugins and guides: Awesome YOURLS on GitHub
  • Questions: GitHub community discussions
  • Official news: blog.yourls.org

Alternatives to consider

Comparable self-hosted projects named in this guide are Shlink, Kutt and Polr. Compare them on the features you need, the server requirements and how you plan to extend them. Choose the one whose setup and plugin model fits your skills.

  • Shlink
  • Kutt
  • Polr

What people use it for

  • Creating short links on your own domain for marketing campaigns
  • Keeping click data and link records on a server you run
  • Extending a URL shortener with PHP plugins
  • Testing a self-hosted shortener for a small site or team

Frequently asked questions

Is YOURLS free?

Yes. The README says YOURLS is free and open source and is released under the MIT license. You can read the LICENSE file in the repository for the full terms.

What do I need to run YOURLS?

You need PHP and a web server. The README excerpt does not give exact versions, so check docs.yourls.org for current requirements.

How do I install YOURLS?

Start by cloning the repository with git clone https://github.com/YOURLS/YOURLS.git. The full setup steps are in the official documentation at docs.yourls.org.

Is YOURLS a hosted service?

No. The README describes YOURLS as something you host yourself on your own server. It does not describe a hosted offering or paid support.

What are the alternatives to YOURLS?

Comparable projects named here are Shlink, Kutt and Polr. Each is a self-hosted option, so compare setup effort, features and plugin support before choosing.

Can I extend YOURLS?

Yes. The README says YOURLS supports plugins. Community plugins are listed in the Awesome YOURLS repository on GitHub.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

YOURLS suits people and developers who want short links on a domain they control and are comfortable running PHP software on their own server. If you want zero setup, a hosted service or paid support, pick a hosted shortener or a different project instead.

Install options & downloads