yourls
10M+
YOURLS is a set of PHP scripts that will allow you to run Your Own URL Shortener.
docker pull yourls
Maintained by:
YOURLS
Where to get help:
the Docker Community Slack, Server Fault, Unix & Linux, or Stack Overflow
Dockerfile
linksWhere to file issues:
https://github.com/YOURLS/docker/issues
Supported architectures: (more info)amd64
, arm32v5
, arm32v6
, arm32v7
, arm64v8
, i386
, mips64le
, ppc64le
, s390x
Published image artifact details:
repo-info repo's repos/yourls/
directory (history)
(image metadata, transfer size, etc)
Image updates:
official-images repo's library/yourls
label
official-images repo's library/yourls
file (history)
Source of this description:
docs repo's yourls/
directory (history)
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.
yourls
server instance$ docker run --name some-yourls --link some-mysql:mysql \
-e YOURLS_SITE="https://example.com" \
-e YOURLS_USER="example_username" \
-e YOURLS_PASS="example_password" \
-d yourls
The YOURLS instance accepts a number of environment variables for configuration, see Environment Variables section below.
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
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/admin/
or http://<host-ip>:8080/admin/
in a browser.
Note: On first instantiation, reaching the root folder will generate an error. Access the YOURLS administration interface via the path /admin/
.
When you start the yourls
image, you can adjust the configuration of the YOURLS instance by passing one or more environment variables on the docker run
command line.
The YOURLS instance accepts a number of environment variables for configuration.
A few notable/important examples for using this Docker image include the following.
YOURLS_SITE
Required.
YOURLS instance URL, no trailing slash, lowercase.
Example: YOURLS_SITE="https://example.com"
YOURLS_USER
Required.
YOURLS instance username.
Example: YOURLS_USER="example_username"
YOURLS_PASS
Required.
YOURLS instance password.
Example: YOURLS_PASS="example_password"
YOURLS_DB_HOST
, YOURLS_DB_USER
, YOURLS_DB_PASS
Optional if linked mysql
container.
Host, user (defaults to root
) and password for the database.
YOURLS_DB_NAME
Optional.
Database name, defaults to yourls
. The database must have been created before installing YOURLS.
YOURLS_DB_PREFIX
Optional.
Database tables prefix, defaults to yourls_
. Only set this when you need to override the default table prefix.
As an alternative to passing sensitive information via environment variables, _FILE
may be appended to the previously listed environment variables, causing the initialization script to load the values for those variables from files present in the container. In particular, this can be used to load passwords from Docker secrets stored in /run/secrets/<secret_name>
files. For example:
$ docker run --name some-yourls -e YOURLS_DB_PASS_FILE=/run/secrets/mysql-root ... -d yourls:tag
Currently, this is supported for YOURLS_DB_HOST
, YOURLS_DB_USER
, YOURLS_DB_PASS
, YOURLS_DB_NAME
, YOURLS_DB_PREFIX
, YOURLS_SITE
, YOURLS_USER
, and YOURLS_PASS
.
docker-compose
or docker stack deploy
Example docker-compose.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
YOURLS_USER: example_username
YOURLS_PASS: example_password
mysql:
image: mysql
restart: always
environment:
MYSQL_ROOT_PASSWORD: example
MYSQL_DATABASE: yourls
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/admin/
, http://localhost:8080/admin/
, or http://<host-ip>:8080/admin/
(as appropriate).
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:
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>-fpm
This variant contains PHP-FPM, which is a FastCGI implementation for PHP. See the PHP-FPM website for more information about PHP-FPM.
In order to use this image variant, some kind of reverse proxy (such as NGINX, Apache, or other tool which speaks the FastCGI protocol) will be required.
Some potentially helpful resources:
WARNING: the FastCGI protocol is inherently trusting, and thus extremely insecure to expose outside of a private container network -- unless you know exactly what you are doing (and are willing to accept the extreme risk), do not use Docker's --publish
(-p
) flag with this image variant.
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.
Docker Official Images are a curated set of Docker open source and drop-in solution repositories.
These images have clear documentation, promote best practices, and are designed for the most common use cases.