Skip to content

Latest commit

 

History

History
107 lines (64 loc) · 4.59 KB

content.md

File metadata and controls

107 lines (64 loc) · 4.59 KB

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

Start a %%IMAGE%% server instance

$ docker run --name some-%%REPO%% --link some-mysql:mysql \
    -e YOURLS_SITE="https://example.com" \
    -e YOURLS_USER="example_username" \
    -e YOURLS_PASS="example_password" \
    -d %%IMAGE%%

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-%%REPO%%s -e YOURLS_DB_HOST=10.1.2.3:3306 \
    -e YOURLS_DB_USER=... -e YOURLS_DB_PASS=... -d %%IMAGE%%

Connect to the YOURLS administration interface

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-%%REPO%% --link some-mysql:mysql -p 8080:80 -d %%IMAGE%%

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/.

Environment Variables

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.

Docker Secrets

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-%%REPO%% -e YOURLS_DB_PASS_FILE=/run/secrets/mysql-root ... -d %%IMAGE%%: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.

%%STACK%%

Run docker stack deploy -c stack.yml %%REPO%% (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).

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.