Portainer Templates logo

Portainer Templates

YOURLS YOURLS

Stack

WebTools

URL shortener you run yourself: short links on your own address with custom keywords, click stats with referrers and countries, bookmarklets and an API for making links from scripts. Source: https://github.com/YOURLS/YOURLS

Source details

Repo: YOURLS/YOURLS
Stars: 12.3k
Forks: 2k
Language: PHP
License: MIT
Latest: 1.10.6 · 1 month ago
Updated: 1 day ago
Website: yourls.org/

Configuration

Type
Compose
Platform
linux
Env vars
YOURLS_URL=''YOURLS_ADMIN_USER=adminYOURLS_ADMIN_PASSWORD=''YOURLS_DB_PASSWORD=''YOURLS_COOKIE_KEY=''YOURLS_PORT=8400
Restart
unless-stopped
Source
Repo

Template by NotAFlightRisk·Source

Report issue

Notes

Fill in the address, admin password and database password before you deploy, since the stack won't start without them. The address has to be exactly what you'll type in the browser, like http://192.168.1.20:8400: the port you're using, all lowercase, and no slash at the end. YOURLS builds every short link, page and button from it, so if it's wrong /admin sends you off to that address to install, any page you do reach has no styling and won't shorten anything, and short links point at the wrong place. To fix it, change the address in the stack's environment variables and redeploy. Then open /admin on that address (the bare address just says Forbidden, that's normal), click Install YOURLS once to set up the database, and log in with the admin username and password from the form. The login lives in the stack's environment variables, so that's where you change the password. The install adds three sample links to yourls.org, delete them if you like. Short links are public, and so are their stats pages (add a + to any short link), which load their charts and site icons from Google. For scripts, use the signature token under Tools rather than your password, and set a cookie key so the token survives updates. Links and stats live in the db-data volume. Docs: yourls.org/docs

Services

yourls

Configuration

Image
yourls:1
Ports
${YOURLS_PORT:-8400}:8080
Env vars
YOURLS_SITE=${YOURLS_URL:?Set the address you'll open it on}YOURLS_USER=${YOURLS_ADMIN_USER:-admin}YOURLS_PASS=${YOURLS_ADMIN_PASSWORD:?Set an admin password}YOURLS_COOKIEKEY=${YOURLS_COOKIE_KEY:-}YOURLS_DB_HOST=dbYOURLS_DB_NAME=yourlsYOURLS_DB_USER=yourlsYOURLS_DB_PASS=${YOURLS_DB_PASSWORD:?Set a database password}
Restart
unless-stopped

Image details

Pulls: 23.7M
User: library
Created: Jul 18, 2018
Updated: 10 days ago
Status: active

db

Configuration

Image
mariadb:11.4
Volumes
/var/lib/mysql : db-data
Env vars
MARIADB_DATABASE=yourlsMARIADB_USER=yourlsMARIADB_PASSWORD=${YOURLS_DB_PASSWORD:?Set a database password}MARIADB_RANDOM_ROOT_PASSWORD=1
Restart
unless-stopped

Image details

Pulls: 3.2B
User: stackbrew
Created: Nov 25, 2014
Updated: 3 days ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying YOURLS

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select YOURLS, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  yourls:
    image: yourls:1
    restart: unless-stopped
    ports:
      - "${YOURLS_PORT:-8400}:8080"
    environment:
      YOURLS_SITE: ${YOURLS_URL:?Set the address you'll open it on}
      YOURLS_USER: ${YOURLS_ADMIN_USER:-admin}
      YOURLS_PASS: ${YOURLS_ADMIN_PASSWORD:?Set an admin password}
      YOURLS_COOKIEKEY: ${YOURLS_COOKIE_KEY:-}
      YOURLS_DB_HOST: db
      YOURLS_DB_NAME: yourls
      YOURLS_DB_USER: yourls
      YOURLS_DB_PASS: ${YOURLS_DB_PASSWORD:?Set a database password}
    depends_on:
      db:
        condition: service_healthy

  db:
    image: mariadb:11.4
    restart: unless-stopped
    environment:
      MARIADB_DATABASE: yourls
      MARIADB_USER: yourls
      MARIADB_PASSWORD: ${YOURLS_DB_PASSWORD:?Set a database password}
      MARIADB_RANDOM_ROOT_PASSWORD: "1"
    volumes:
      - db-data:/var/lib/mysql
    healthcheck:
      test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"]
      interval: 5s
      timeout: 5s
      retries: 20

volumes:
  db-data:

Or deploy it directly from the source:

git clone https://github.com/NotAFlightRisk/portainer-templates-extras
cd portainer-templates-extras
docker compose -f apps/yourls/compose.yml up -d

More install options in our documentation, or see YOURLS/YOURLS for app-specific guidance.

Container Documentation

yourls Documentation

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

db Documentation

MariaDB Server is a high performing open source relational database, forked from MySQL.

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Image won't pull

Test the pull directly on the host: docker pull yourls:1

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

YOURLS is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • yourls runs yourls:1, starts after db
  • db runs mariadb:11.4

Volumes

A volume is where YOURLS keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/lib/mysql kept in the db-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. YOURLS takes 12 of them, and 4 need a value before it'll start properly:

  • YOURLS_SITE, needs a value
  • YOURLS_USER, defaults to admin
  • YOURLS_PASS, needs a value
  • YOURLS_COOKIEKEY, pulled from your own environment
  • YOURLS_DB_HOST, defaults to db
  • YOURLS_DB_NAME, defaults to yourls
  • YOURLS_DB_USER, defaults to yourls
  • YOURLS_DB_PASS, needs a value
  • MARIADB_DATABASE, defaults to yourls
  • MARIADB_USER, defaults to yourls
  • MARIADB_PASSWORD, needs a value
  • MARIADB_RANDOM_ROOT_PASSWORD, defaults to 1

Restart policy

The restart policy here is unless-stopped, so Docker restarts YOURLS after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like yourls) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

YOURLS is open source, released under the MIT license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set YOURLS up. Add the template list to Portainer once, then deploying YOURLS is a click rather than a wall of config.