From 7225f8dff1384fe610e7e57b69a1c2036af45c2f Mon Sep 17 00:00:00 2001 From: ozh Date: Fri, 10 Apr 2015 22:46:06 +0200 Subject: [PATCH] Smarter domain convention in examples and source In config, readmes, editable files: the generic YOURLS install will be http://your-own-domain-here.com/ so that noob users get an obvious warning when they misconfigure something In source comments, presumably read by hackers who have a clue, the generic YOURLS install will be http://sho.rt/. The generic long URL can be http://example.com/something-whatever Closes #1841 --- includes/functions-formatting.php | 2 +- includes/functions.php | 2 +- readme.html | 8 ++++---- sample-public-front-page.txt | 2 +- sample-remote-api-call.txt | 2 +- user/config-sample.php | 4 ++-- yourls-loader.php | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/includes/functions-formatting.php b/includes/functions-formatting.php index c166efe..7f45a8f 100644 --- a/includes/functions-formatting.php +++ b/includes/functions-formatting.php @@ -51,7 +51,7 @@ function yourls_string2htmlid( $string ) { } /** - * Make sure a link keyword (ie "1fv" as in "site.com/1fv") is valid. + * Make sure a link keyword (ie "1fv" as in "http://sho.rt/1fv") is valid. * */ function yourls_sanitize_string( $string ) { diff --git a/includes/functions.php b/includes/functions.php index f05f2e4..c02b418 100644 --- a/includes/functions.php +++ b/includes/functions.php @@ -1885,7 +1885,7 @@ function yourls_is_mobile_device() { } /** - * Get request in YOURLS base (eg in 'http://site.com/yourls/abcd' get 'abdc') + * Get request in YOURLS base (eg in 'http://sho.rt/yourls/abcd' get 'abdc') * */ function yourls_get_request() { diff --git a/readme.html b/readme.html index 13ac4b6..85665e1 100644 --- a/readme.html +++ b/readme.html @@ -337,7 +337,7 @@
  • Open user/config.php with a raw text editor (like Notepad) and fill in the required settings
  • Upload the unzipped files to your domain public_html or www folder
  • Create a new database (see Configuration – you can also use an existing one)
    • -
  • Point your browser to http://yoursite.com/admin/
    • +
  • Point your browser to http://your-own-domain-here.com/admin/

    • Upgrade

    @@ -345,7 +345,7 @@
  • Backup the database!
  • Unzip the YOURLS archive
  • Upload files to your server, overwriting your existing install
    • -
  • Point your browser to http://yoursite.com/admin/
    • +
  • Point your browser to http://your-own-domain-here.com/admin/
  • Tip: you can now move your config.php file to the /user directory
    • @@ -357,7 +357,7 @@
  • Unzip the YOURLS archive, upload the files
  • Copy config-sample.php to config.php and fill in details. Don't start with your old config file, use the new sample config file.
  • In your new config.php, add the defines for YOURLS_DB_TABLE_URL and YOURLS_DB_TABLE_NEXTDEC you had in your previous config file -
  • Point your browser to http://yoursite.com/admin/ and follow instructions
    • +
  • Point your browser to http://your-own-domain-here.com/admin/ and follow instructions
  • After upgrade is well and over, remove the define YOURLS_DB_TABLE_NEXTDEC from your config file
    • @@ -469,7 +469,7 @@

    Usage

    -

    You need to send parameters to http://yoursite.com/yourls-api.php either via GET or POST (remember to URL encode parameters if via GET). These parameters are:

    +

    You need to send parameters to http://your-own-domain-here.com/yourls-api.php either via GET or POST (remember to URL encode parameters if via GET). These parameters are: