guessi/docker-yourls
guessi/docker-yourls has 40 GitHub stars and 19 forks. GitHot measured 0 stars in 24 hours. Last checked 2026-11-16 03:38 UTC. Last push 2026-11-15.
Measured star growth
- in 24h
- 0
- in 7 days
- Update delayed
- in 15 days
- Update delayed
- in 1 month
- Update delayed
Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.
About
Dockerize YOURLS service (Shorten URL Service)
Developer ToolsREADME.md
OriginalDockerize YOURLS - Your Own URL Shortener
Before start, things you need to know...
Difference between Official Build and why this project exist?
Back in 2017, I was a user of YOURLS (Great thanks to upstream maintainers). I found it's hard to build YOURLS into container image so I publish my customized YOURLS image build and scripts on May 7, 2017. Around half year later, upstream YOURLS maintainers published an official repo called "YOURLS/docker" to build container images for YOURLS project on Nov 11, 2017. So it became two different image repositories.
Should I use it or maybe Official build is better?
Ideally, official build should receive better support and it is always encourage to try Official Build first. The main differences between two projects is the way image build and w/wo plugins pre-loaded.
As time goes by, please take this project as a quick start guide for YOURLS and please don't get me wrong, I'm not pushing you away (existed users), if you still like this project? it is always welcome to stay here :-)
Integrated Items
- Yourls - 1.10.6
| Container image tag | Mobile-Detect version | PHP version | OS version | Remark |
|---|---|---|---|---|
| 1.10.6-0 (alias of 1.10.6) | 4.11.0 | PHP 8.5 | Debian 13 | Build with PHP 8.5, Debian 13 |
| 1.9.2-11 (alias of 1.9.2) | 3.74.3 | PHP 8.3 | Debian 12 | Final 1.9.2 build, php.ini-production |
| 1.9.2-10 | 3.74.3 | PHP 8.3 | Debian 12 | No code change, regular re-build |
Integrated Plugins
- timezones
- 302-instead
- dont-track-admins
- fallback_url_config
- force-lowercase
- mobile-detect
- dont-log-bots
- dont-log-crawler - removed after 1.9.2-8 due to project link is dead.
- dont-log-health-checker
Usage
[!IMPORTANT] You should always change the default username/password pairs for both MySQL and YOURLS.
[!WARNING]
docker-compose.yamlusesmysql:8.4since 1.10.6. An existingmysql-datavolume created bymysql:5.7can not be reused directly. Runbackup.shwith the old stack first, then follow Restore backup from backup file on the new one.
To run YOURLS service with customized config
$ vim env.mysql
$ vim env.yourls
$ docker compose up [--build] [-d]
Dashboard
- Default Login Page: http://localhost/admin/
- Default Username: see env.yourls
- Default Password: see env.yourls
Advanced
Create database backup
Execute backup.sh to get regular backup
Restore backup from backup file
Make sure there is no container running
$ docker compose down
$ docker ps
Cleanup "mysql-data" volume
$ docker volume rm yourls_mysql-data
Make sure there is no sql file under "mysql-initdb" volume
$ rm -vf ./volumes/docker-entrypoint-initdb.d/*
Move the backup sql file to "mysql-initdb" volume
$ cp -vf ./mysql-dump-YYYYMMDD-hhmmss.sql ./volumes/docker-entrypoint-initdb.d/
$ docker compose up -d
FAQ
Why there would have no homepage for YOURLS?
Check the answer at the link below
- https://github.com/orgs/YOURLS/discussions/3638#discussioncomment-7192119
How can I use non-default password or variables?
simply modify the variables inside `env.*` before your first run.
Limitations for environment files
1. The value of `YOURLS_DB_PASS` inside `env.yourls` **SHOULD BE** exactly the same as `MYSQL_PASSWORD` in `env.mysql`.
2. The value of `YOURLS_DB_USER` inside `env.yourls` **SHOULD BE** exactly the same as `MYSQL_USER` in `env.mysql.
3. All variables inside `env.mysql` and `env.yourls` **SHOULD NOT** contain `'=' (equal sign)`, `' ' (space)`, `'#' (number sign)`.
Why it will show Could not auto-encrypt passwords. when log into admin page?
Check the FAQ for YOURLS for more details
- https://yourls.org/docs/guide/essentials/credentials#faq
Why it will show Could not write file .htaccess in YOURLS root directory.?
It should only happen at 1st time deployment, you may safely ignore it.
Any others?
Here are some useful links for you
- https://yourls.org/docs
- https://yourls.org/docs/category/troubleshooting
- https://github.com/orgs/YOURLS/discussions