YOURLS Linknotes on running YOURLS
Posted 14 March 2017 · filed under yourls, notes

Short links on my own YOURLS box

A post about my YOURLS box, and the box itself.

I run YOURLS on a small box in the hall cupboard. It sits behind the router and does one job: turn long addresses into short ones I can paste into a text message or a README without the line wrapping into the next paragraph. The form is the whole interface.

Nothing costs money, nothing needs an account, and links do not expire. The same address always gives the same short link, so I stopped worrying about duplicates. Scripts can do the same with a plain GET; the details are below.

Usage

YOURLS Link: a YOURLS link shortener with a GET and POST API. No account and no API key.

Make a link. The answer is JSON and the short link is in "shorturl":

    https://www.yourlslink.com/api/shorten.php?url=https%3A%2F%2Fexample.com%2Fa%2Flong%2Faddress

From a shell, as a GET, a form or JSON:

    curl -G https://www.yourlslink.com/api/shorten.php --data-urlencode 'url=https://example.com/page?a=1&b=2'
    curl https://www.yourlslink.com/api/shorten.php -d 'url=https://example.com/a/long/address'
    curl https://www.yourlslink.com/api/shorten.php -H 'Content-Type: application/json' -d '{"url":"https://example.com/page"}'

Pick the keyword yourself, 1 to 64 letters, digits, - or _:

    https://www.yourlslink.com/api/shorten.php?keyword=my-name&url=https%3A%2F%2Fexample.com%2Fa%2Flong%2Faddress

Follow a link, or see where it leads without going there:

    https://www.yourlslink.com/<keyword>         redirects
    https://www.yourlslink.com/<keyword>+        the address as text

Percent-encode url, or put it last: an address written out as it is
runs to the end of the line, with its own ? and & in it.

The same address gives the same short link every time, unless you name
it yourself. A keyword that is taken answers 409. Links do not expire.

Part 2 soon.