HUB
Sign inSign up
yourls logo

nefald/yourls

By nefald

•Updated 1 day ago

YOURLS URL shortener with curated plugins, French translation and OIDC authentication.

Image
0

3.0K

nefald/yourls repository overview

⁠YOURLS — image Docker Nefald

YOURLS Image Docker Pulls

Image Docker YOURLS basée sur l'image officielle yourls⁠ (variante Apache), enrichie de plugins, de la traduction française et d'une authentification OIDC.

⁠🏷️ Versionnement

Les tags suivent le format <version YOURLS>-<révision> :

TagExempleMobileUsage
X.Y.Z-N1.10.6-1non (jamais réécrit)à épingler en production
X.Y.Z1.10.6oui, dernière révision de cette version YOURLS
latestoui, dernière releasedéconseillé en production
X.Y.Z-N-<branche>1.10.6-1-feature-fooouitests uniquement
  • X.Y.Z est la version de l'image officielle yourls utilisée comme base (FROM yourls:X.Y.Z).
  • N compte nos révisions sur cette base : plugins, scripts, configuration.

Chaque image porte les labels OCI org.opencontainers.image.version et org.opencontainers.image.revision (commit Git du build) :

docker inspect nefald/yourls:1.10.6-1 --format '{{json .Config.Labels}}'

⁠🔌 Plugins inclus

Tous les plugins sont épinglés sur un commit. Ils sont installés mais doivent être activés depuis l'administration (/admin/plugins.php).

PluginDossierRôle
404 If Not Found⁠404-if-not-found404 pour les mots-clés inexistants
Antispam⁠antispamFiltrage des URL de spam
Change Password⁠change-passwordChangement de mot de passe
Custom Protocol⁠custom-protocolProtocoles personnalisés
Database Users⁠db-usersComptes stockés en base
Don't Log Bots⁠dont-log-botsIgnore les robots dans les stats
No Tracking Admins⁠no-tracking-adminsIgnore les clics des admins
Fallback URL⁠fallback-urlRedirection par défaut
GeoIP Update⁠geoip-updateMise à jour de la base GeoIP
Favicon⁠faviconFavicon
Fix YouTube Titles⁠fix-youtube-titlesTitres YouTube
Force Lowercase⁠force-lowercaseMots-clés en minuscules
Mass Remove Links⁠mass-remove-linksSuppression en masse
Timezones⁠timezonesFuseaux horaires
Upload and Shorten⁠upload-and-shortenEnvoi de fichiers
QR Codeqr-codeQR codes
OIDC⁠ (tag 0.3.3)oidcAuthentification OpenID Connect

Traduction : YOURLS-fr_FR⁠ (tag 1.10), activée avec YOURLS_LANG=fr_FR.

⁠🏗️ Installation

services:
  yourls:
    image: nefald/yourls:1.10.6-1
    ports:
      - "8080:8080"   # Apache écoute sur 8080 dans l'image officielle
    environment:
      YOURLS_SITE: https://sho.rt
      YOURLS_USER: admin
      YOURLS_PASS: change-me
      YOURLS_DB_HOST: mariadb
      YOURLS_DB_NAME: yourls
      YOURLS_DB_USER: yourls
      YOURLS_DB_PASS: change-me
      YOURLS_LANG: fr_FR
    depends_on:
      - mariadb
    restart: unless-stopped

  mariadb:
    image: mariadb:12.3   # LTS
    environment:
      MARIADB_ROOT_PASSWORD: change-me
      MARIADB_DATABASE: yourls
      MARIADB_USER: yourls
      MARIADB_PASSWORD: change-me
    volumes:
      - mariadb_data:/var/lib/mysql
    restart: unless-stopped

volumes:
  mariadb_data:

Monter un volume sur /var/www/html/user masque les plugins de l'image : préférer des montages ciblés.

⁠⚙️ Variables d'environnement

Variables de l'image officielle : YOURLS_SITE, YOURLS_USER, YOURLS_PASS, YOURLS_DB_*, YOURLS_LANG, YOURLS_PRIVATE, YOURLS_COOKIEKEY, etc. (voir la documentation officielle⁠).

Variables OIDC, injectées au démarrage dans user/oidc-settings.php :

VariableDéfautDescription
OIDC_BASE_URLURL du fournisseur OIDC
OIDC_CLIENT_NAMEIdentifiant client
OIDC_CLIENT_SECRETSecret client
OIDC_REDIRECT_URLURL de retour
OIDC_BYPASS_YOURLS_AUTHtruetrue : OIDC remplace l'authentification YOURLS
OIDC_SUB_IDsub OIDC associé à l'administrateur
YOURLS_ADMIN_USER$YOURLS_USERUtilisateur YOURLS associé à OIDC_SUB_ID

⁠🩺 Santé du conteneur

HEALTHCHECK CMD curl -fsS -o /dev/null http://localhost:8080/admin/

⁠⬆️ Mise à jour

  1. Dump de la base avant toute montée de version YOURLS.
  2. Changer le tag dans le Compose, puis redéployer.
  3. Se connecter à /admin : YOURLS propose la mise à jour du schéma si nécessaire (1.10.6 : db_version 507).
  4. Vérifier redirections, statistiques et connexion OIDC.

Maintenu par Nefald Community⁠ · Discord⁠

Tag summary

Content type

Image

Digest

sha256:9f8d4986f…

Size

202.8 MB

Last updated

1 day ago

docker pull nefald/yourls