yourls

Estimated reading time: 6 minutes

YOURLS is a set of PHP scripts that will allow you to run Your Own URL Shortener.

GitHub repo: https://github.com/YOURLS/docker-yourls

Library reference

This content is imported from the official Docker Library docs, and is provided by the original uploader. You can view the Docker Store page for this image at https://store.docker.com/images/yourls

Supported tags and respective Dockerfile links

Quick reference

What is YOURLS?

YOURLS is a set of PHP scripts that will allow you to run Your Own URL Shortener. You’ll have full control over your data, detailed stats, analytics, plugins, and more. It’s free.

github.com/YOURLS/YOURLS

logo

How to use this image

$ docker run --name some-yourls --link some-mysql:mysql \
    -e YOURLS_SITE="https://example.com" \
    -d yourls

The following environment variables are also honored for configuring your YOURLS instance:

  • -e YOURLS_DB_HOST=... (defaults to the IP and port of the linked mysql container)
  • -e YOURLS_DB_USER=... (defaults to “root”)
  • -e YOURLS_DB_PASS=... (defaults to the value of the MYSQL_ROOT_PASSWORD environment variable from the linked mysql container)
  • -e YOURLS_DB_NAME=... (defaults to “yourls”)
  • -e YOURLS_TABLE_PREFIX=... (defaults to “”, only set this when you need to override the default table prefix in wp-config.php)
  • -e YOURLS_COOKIEKEY=... (default to unique random SHA1s)
  • -e YOURLS_SITE=... (yourls instance url)

If the YOURLS_DB_NAME specified does not already exist on the given MySQL server, it will be created automatically upon startup of the yourls container, provided that the YOURLS_DB_USER specified has the necessary permissions to create it.

If you’d like to be able to access the instance from the host without the container’s IP, standard port mappings can be used:

$ docker run --name some-yourls --link some-mysql:mysql -p 8080:80 -d yourls

Then, access it via http://localhost:8080 or http://host-ip:8080 in a browser.

If you’d like to use an external database instead of a linked mysql container, specify the hostname and port with YOURLS_DB_HOST along with the password in YOURLS_DB_PASS and the username in YOURLS_DB_USER (if it is something other than root):

$ docker run --name some-yourlss -e YOURLS_DB_HOST=10.1.2.3:3306 \
    -e YOURLS_DB_USER=... -e YOURLS_DB_PASS=... -d yourls

... via docker stack deploy or docker-compose

Example stack.yml for yourls:

version: '3.1'

services:

  yourls:
    image: yourls
    restart: always
    ports:
      - 8080:80
    environment:
      YOURLS_DB_PASS: example
      YOURLS_SITE: https://example.com

  mysql:
    image: mysql:5.7
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: example

Try in PWD

Run docker stack deploy -c stack.yml yourls (or docker-compose -f stack.yml up), wait for it to initialize completely, and visit http://swarm-ip:8080, http://localhost:8080, or http://host-ip:8080 (as appropriate).

Adding additional libraries / extensions

This image does not provide any additional PHP extensions or other libraries, even if they are required by popular plugins. There are an infinite number of possible plugins, and they potentially require any extension PHP supports. Including every PHP extension that exists would dramatically increase the image size.

If you need additional PHP extensions, you’ll need to create your own image FROM this one. The documentation of the php image explains how to compile additional extensions.

The following Docker Hub features can help with the task of keeping your dependent images up-to-date:

  • Automated Builds let Docker Hub automatically build your Dockerfile each time you push changes to it.
  • Repository Links can ensure that your image is also rebuilt any time yourls is updated.

Image Variants

The yourls images come in many flavors, each designed for a specific use case.

yourls:<version>

This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.

yourls:<version>-alpine

This image is based on the popular Alpine Linux project, available in the alpine official image. Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.

This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use musl libc instead of glibc and friends, so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn’t have an issue with this, so this variant is usually a very safe choice. See this Hacker News comment thread for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.

To minimize image size, it’s uncommon for additional related tools (such as git or bash) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the alpine image description for examples of how to install packages if you are unfamiliar).

License

View license information for the software contained in this image.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

Some additional license information which was able to be auto-detected might be found in the repo-info repository’s yourls/ directory.

As for any pre-built image usage, it is the image user’s responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

library, sample, yourls