➤ Configuration (in user/config.php ) ➤ MySQL settings YOURLS_DB_USER

your MySQL username

Example: define( 'YOURLS_DB_USER', 'joe' );

your MySQL username Example: YOURLS_DB_PASS

your MySQL password

Example: define( 'YOURLS_DB_PASS', 'MySeCreTPaSsW0rd' );

your MySQL password Example: YOURLS_DB_NAME : The database name

Example: define( 'YOURLS_DB_NAME', 'yourls' );

: The database name Example: YOURLS_DB_HOST

The database host

Example: define( 'YOURLS_DB_HOST', 'localhost' );

The database host Example: YOURLS_DB_PREFIX

The name prefix for all the tables YOURLS will need

Example: define( 'YOURLS_DB_PREFIX', 'yourls_' ); ➤ Site options YOURLS_SITE

Your (hopefully short) domain URL, no trailing slash, lowercase. If you pick the non-www version of your domain, don't use the www version in your browser (and vice-versa)

Example: define( 'YOURLS_SITE', 'http://ozh.in' );

Your (hopefully short) domain URL, no trailing slash, lowercase. If you pick the non-www version of your domain, don't use the www version in your browser (and vice-versa) Example: YOURLS_HOURS_OFFSET

Timezone GMT offset

Example: define( 'YOURLS_HOURS_OFFSET', '-5' );

Timezone GMT offset Example: YOURLS_PRIVATE

Private means the admin area will be protected with login/pass as defined below. See Private or Public for more.

Example: define( 'YOURLS_PRIVATE', true );

Private means the admin area will be protected with login/pass as defined below. See Private or Public for more. Example: YOURLS_UNIQUE_URLS

Allow multiple short URLs for a same long URL

Set to true to allow only one pair of shortURL/longURL (default YOURLS behavior), or to false to allow creation of multiple short URLs pointing to the same long URL (as bit.ly does)

Example: define( 'YOURLS_UNIQUE_URLS', true );

Allow multiple short URLs for a same long URL Set to to allow only one pair of shortURL/longURL (default YOURLS behavior), or to to allow creation of multiple short URLs pointing to the same long URL (as bit.ly does) Example: YOURLS_COOKIEKEY

A random secret hash used to encrypt cookies. You don't have to remember it, make it long and complicated. Hint: generate a unique one at https://yourls.org/cookie

Example: define( 'YOURLS_COOKIEKEY', 'qQ4KhL_pu|s@Zm7n#%:b^{A[vhm' );

A random secret hash used to encrypt cookies. You don't have to remember it, make it long and complicated. Hint: generate a unique one at https://yourls.org/cookie Example: yourls_user_passwords

A list of username(s) and password(s) allowed to access the site if private

Passwords can either be in plain text, or encrypted: see https://yourls.org/userpassword for more information.

Example: 'joe' => 'mypassword' ➤ URL Shortening settings YOURLS_URL_CONVERT

URL shortening method: base 36 or 62 . See FAQ for more explanations

URL shortening method: base or . See FAQ for more explanations yourls_reserved_URL

A list of reserved keywords that won't be used as short URLs. Define here negative, unwanted or potentially misleading keywords

Example: 'porn', 'faggot', 'sex', 'nigger', 'fuck', 'cunt', 'dick' ➤ Optional settings YOURLS_PRIVATE_INFOS

If YOURLS_PRIVATE is set to true , you can still make stat pages public. To do so, define with:

define('YOURLS_PRIVATE_INFOS', false);

If is set to , you can still make stat pages public. To do so, define with: YOURLS_PRIVATE_API

If YOURLS_PRIVATE is set to true , you can still make your API public. To do so, define with:

define('YOURLS_PRIVATE_API', false);

If is set to , you can still make your API public. To do so, define with: YOURLS_NOSTATS

If YOURLS_NOSTATS is set to true , redirects won't be logged and there will be not stats available.

➤ Advanced settings You can install YOURLS behind a firewall or a proxy: see Proxy Support

File includes/Config/Config.php contains a few more undocumented but self explanatory and commented settings. Add them to your own config.php if you know what you're doing.

contains a few more undocumented but self explanatory and commented settings. Add them to your own if you know what you're doing. There are numerous tips and guides on the Wiki, be sure to read them.

➤ Plugins for YOURLS ➤ Plugins? Plugins are additional PHP scripts that extend the functionalities or features of YOURLS. The core of YOURLS is designed to be as light as possible and avoid bloat (implementing functions not everybody needs) and to allow for easy customization. Using the plugin architecture, you can add new features to YOURLS without having to modify core files. This way, your changes won't be lost when you upgrade your YOURLS installation and you can easily activate and deactivate a plugin from the admin interface. There's a growing number of plugins available: check the Plugin list. ➤ Documentation Several sample plugins are included in the archive. Read the source and learn the concept. It's easy and fun! Check the plugin API documentation to learn more