github.com/tiredofit/docker-yourls
About
This will build a container for YOURLS, a URL Link shortener.
This image needs manual configuration to get configuration running, it is not fully dynamic specifically if you add plugins!. Please see invidividual plugin documentation and manually edit the data/config file for these additions.
This Container uses Alpine:3.13 as a base.
Maintainer
- [Dave Conroy](dave at tiredofit dot ca)
Table of Contents
- Introduction
- Authors
- Table of Contents
- Prerequisites
- Installation
- Configuration
- Maintenance
- References
Prerequisites and Assumptions
This container requires the use of an external MariaDB database container.
Installation
Automated builds of the image are available on Docker Hub
docker pull hub.docker.com/r/tiredofit/yourlsQuick Start
-
The quickest way to get started is using docker-compose. See the examples folder for a working docker-compose.yml that can be modified for development or production use.
-
Set various environment variables to understand the capabiltiies of this image.
-
Map persistent storage for access to configuration and data files for backup.
Configuration
Persistent Storage
The following directories are used for configuration and can be mapped for persistent storage.
| Directory | Description |
|---|---|
| /www/logs | PHP and NginX Logs |
| /data/ | Plugins and Configuration Data |
Environment Variables
Below is the complete list of available options that can be used to customize your installation.
| Parameter | Description | Default |
|---|---|---|
DB_HOST |
External MariaDB Container (e.g. yourls-db) | |
DB_NAME |
Database Name (e.g. yourls) | |
DB_USER |
User with Database Permissions (e.g. yourls) | |
DB_PASS |
Password for above user (e.g. userpassword) | |
ADMIN_USER |
Administrative User (e.g. admin) | |
ADMIN_PASS |
Password for Administrative User (e.g. password) | |
SITE_NAME |
Site Name | |
SITE_URL |
Site URL | |
DEBUG |
Set application to Debug Mode to Display Queries | FALSE |
Networking
The following ports are exposed.
| Port | Description |
|---|---|
| 80 | HTTP |
Maintenance
Shell Access
For debugging and maintenance purposes you may want access the containers shell.
docker exec -it (whatever your container name is e.g. yourls) bash