APP-YOURLS
Purpose
YOURLS is a set of PHP scripts that will allow you to run Your Own URL Shortener, on your server. You will have full control over your data, detailed stats, analytics, plugins, and more. It's free and open-source.
Properties
| Stack-Description | YOURLS url shortener |
|---|---|
| Stack-Image | docker.msg.team/ps/docker-stack-app-yourls |
| Stack-Version | 1.9.2 |
| Stack-Release | 20230320 |
| Product-Name | YOURLS |
| Product-Vendor | |
| Product-Contact | https://yourls.org |
| Product-Model | Open Source |
| Product-License | MIT |
| Product-Limits | none |
| Implementation Base | PHP |
| Execution Base | nginx + php-fpm |
| Initial Start Time | 30s |
| Documentation | https://yourls.org/ |
Topology
The stack consists of two containers:
- app-yourls: the YOURLS application.
- app-yourls-mysel: the YOURLS database
Configuration
| Variable Name | Default | Meaning | |
See also the variables which control integration of the stack into the reverse proxy.
For changes to take effect the stack has to be reinstalled.
First Steps
The admin frontend can be reached at http(s)://<your-server>/app-yourls/admin.
At the first install click then on "Install" and then continue to the admin page.
The default first user hast the username "username" and the password "password".
Your can add new users by editing the config.php with
** YOURLS will auto encrypt plain text passwords in this file
** Read http://yourls.org/userpassword for more information */
$yourls_user_passwords = [
'username' => 'phpass:!2a!08!8OofT/ErMpFP953x0ODaNel3N4QWkPH73XobjlEywuXK0Du4tojEC' /* Password encrypted by YOURLS */ ,
// 'username2' => 'password2',
];
You can also connect to an SSO (OpenID Connect) provider by activating the "oidc" plugin in the admin page and by activating the following configartion in the config.php
* OIDC Pluging
*/
//define( 'OIDC_BASE_URL', 'https://<your keycloak server>/auth/realms/<your realm>/' );
//define( 'OIDC_CLIENT_NAME', 'yourls-dev' );
//define( 'OIDC_CLIENT_SECRET', 'c688c1cc-3089-4980-abc9-a01057fc11b3' );
// Option 1: link OIDC users to local YOURLS users
//$oidc_profiles = array(
// '<username>' => '<user id from keycloak or sub>',
//);
// Option 2, all users on OIDC platform have YOURLS accounts. uses 'preferred_username' attribute
//define( 'OIDC_BYPASS_YOURLS_AUTH', true );
Administration Commands
Related Documents