Scriptlog Docs

Scriptlog Documentation

Code reference for the Scriptlog codebase

User Tools

Site Tools

You are here: start » scriptlog » install » setup
Trace:
scriptlog:install:setup

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

scriptlog:install:setup [2026/09/26 09:09] – admin adminscriptlog:install:setup [2026/09/26 09:17] (current) – admin admin
Line 12: Line 12:
 ======= Includes ======= ======= Includes =======
  
-  ^ Mode ^ Target ^ Line ^ +^ Mode ^ Target ^ Line ^ 
-  | ''require'' | ''require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . 'check-engine.php';'' | 15 | +| ''require'' | ''require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . 'check-engine.php';'' | 15 | 
-  | ''require'' | ''require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . 'dbtable.php';'' | 16 |+| ''require'' | ''require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . 'dbtable.php';'' | 16 |
  
 ======= Functions (25) ======= ======= Functions (25) =======
  
-  ^ Function ^ Line ^ Params ^ Returns ^ Summary ^ +^ Function ^ Line ^ Params ^ Returns ^ Summary ^ 
-  | ''current_url'' | 18 | 0 |  | File setup.php | +| ''current_url'' | 18 | 0 |  | File setup.php | 
-  | ''friendly_mysql_error'' | 47 | 5 |  | friendly_mysql_error() | +| ''friendly_mysql_error'' | 47 | 5 |  | friendly_mysql_error() | 
-  | ''make_connection'' | 71 | 5 |  | make_connection() | +| ''make_connection'' | 71 | 5 |  | make_connection() | 
-  | ''make_secure_connection'' | 103 | 6 |  | make_secure_connection() | +| ''make_secure_connection'' | 103 | 6 |  | make_secure_connection() | 
-  | ''generate_license'' | 131 | 1 |  | generate_license() | +| ''generate_license'' | 131 | 1 |  | generate_license() | 
-  | ''is_table_exists'' | 180 | 3 |  | is_table_exists | +| ''is_table_exists'' | 180 | 3 |  | is_table_exists | 
-  | ''check_dbtable'' | 199 | 2 |  | function check_dbtable | +| ''check_dbtable'' | 199 | 2 |  | function check_dbtable | 
-  | ''install_database_table'' | 220 | 11 |  | install_database_table() | +| ''install_database_table'' | 220 | 11 |  | install_database_table() | 
-  | ''install_i18n_data'' | 596 | 3 |  | install_i18n_data() | +| ''install_i18n_data'' | 596 | 3 |  | install_i18n_data() | 
-  | ''install_privacy_policy_data'' | 888 | 2 |  | install_privacy_policy_data() | +| ''install_privacy_policy_data'' | 888 | 2 |  | install_privacy_policy_data() | 
-  | ''grab_app_key'' | 1088 | 3 |  | grab_app_key() | +| ''grab_app_key'' | 1088 | 3 |  | grab_app_key() | 
-  | ''update_app_key'' | 1111 | 4 |  | update_app_key() | +| ''update_app_key'' | 1111 | 4 |  | update_app_key() | 
-  | ''write_config_file'' | 1137 | 12 |  | write_config_file | +| ''write_config_file'' | 1137 | 12 |  | write_config_file | 
-  | ''env_escape'' | 1256 | 1 |  | Escape value for .env file format | +| ''env_escape'' | 1256 | 1 |  | Escape value for .env file format | 
-  | ''write_env_file'' | 1278 | 12 |  | Write .env file with environment variables | +| ''write_env_file'' | 1278 | 12 |  | Write .env file with environment variables | 
-  | ''remove_bad_characters'' | 1326 | 8 |  | remove_bad_characters() | +| ''remove_bad_characters'' | 1326 | 8 |  | remove_bad_characters() | 
-  | ''escapeHTML'' | 1360 | 1 |  | Escape HTML Function | +| ''escapeHTML'' | 1360 | 1 |  | Escape HTML Function | 
-  | ''installation_key'' | 1371 | 1 |  | installation_key | +| ''installation_key'' | 1371 | 1 |  | installation_key | 
-  | ''convert_memory_used'' | 1393 | 1 |  | convert_memory_used() | +| ''convert_memory_used'' | 1393 | 1 |  | convert_memory_used() | 
-  | ''setup_base_url'' | 1409 | 2 |  | setup_base_url() | +| ''setup_base_url'' | 1409 | 2 |  | setup_base_url() | 
-  | ''purge_installation'' | 1426 | 0 |  | purge_installation() | +| ''purge_installation'' | 1426 | 0 |  | purge_installation() | 
-  | ''generate_random_key_filename'' | 1464 | 0 | ''string'' | Generate a random filename for encryption key | +| ''generate_random_key_filename'' | 1464 | 0 | ''string'' | Generate a random filename for encryption key | 
-  | ''generate_defuse_key'' | 1483 | 0 |  | Generate and save Defuse encryption key outside document root | +| ''generate_defuse_key'' | 1483 | 0 |  | Generate and save Defuse encryption key outside document root | 
-  | ''generate_table_prefix'' | 1536 | 1 |  | genereate_table_prefix() | +| ''generate_table_prefix'' | 1536 | 1 |  | genereate_table_prefix() | 
-  | ''generate_server_config'' | 1569 | 0 |  | Generate server config file during installation |+| ''generate_server_config'' | 1569 | 0 |  | Generate server config file during installation |
  
  
Line 63: Line 63:
 friendly_mysql_error() friendly_mysql_error()
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$errno'' | ''(untyped)'' | //required// |  | +|  ''$errno'' |  ''(untyped)'' |  //required// |   | 
-  | ''$error'' | ''(untyped)'' | //required// |  | +|  ''$error'' |  ''(untyped)'' |  //required// |   | 
-  | ''$host'' | ''(untyped)'' | //required// |  | +|  ''$host'' |  ''(untyped)'' |  //required// |   | 
-  | ''$username'' | ''(untyped)'' | //required// |  | +|  ''$username'' |  ''(untyped)'' |  //required// |   | 
-  | ''$dbname'' | ''(untyped)'' | //required// |  |+|  ''$dbname'' |  ''(untyped)'' |  //required// |   |
  
  
Line 79: Line 79:
 make_connection() make_connection()
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$host'' | ''(untyped)'' | //required// |  | +|  ''$host'' |  ''(untyped)'' |  //required// |   | 
-  | ''$username'' | ''(untyped)'' | //required// |  | +|  ''$username'' |  ''(untyped)'' |  //required// |   | 
-  | ''$passwd'' | ''(untyped)'' | //required// |  | +|  ''$passwd'' |  ''(untyped)'' |  //required// |   | 
-  | ''$dbname'' | ''(untyped)'' | //required// |  | +|  ''$dbname'' |  ''(untyped)'' |  //required// |   | 
-  | ''$dbport'' | ''(untyped)'' | //required// |  |+|  ''$dbport'' |  ''(untyped)'' |  //required// |   |
  
  
Line 95: Line 95:
 make_secure_connection() make_secure_connection()
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$host'' | ''(untyped)'' | //required// |  | +|  ''$host'' |  ''(untyped)'' |  //required// |   | 
-  | ''$username'' | ''(untyped)'' | //required// |  | +|  ''$username'' |  ''(untyped)'' |  //required// |   | 
-  | ''$passwd'' | ''(untyped)'' | //required// |  | +|  ''$passwd'' |  ''(untyped)'' |  //required// |   | 
-  | ''$dbname'' | ''(untyped)'' | //required// |  | +|  ''$dbname'' |  ''(untyped)'' |  //required// |   | 
-  | ''$dbport'' | ''(untyped)'' | //required// |  | +|  ''$dbport'' |  ''(untyped)'' |  //required// |   | 
-  | ''$ca'' | ''(untyped)'' | //required// |  |+|  ''$ca'' |  ''(untyped)'' |  //required// |   |
  
  
Line 112: Line 112:
 generate_license() generate_license()
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$suffix'' | ''(untyped)'' | ''null'' |  |+|  ''$suffix'' |  ''(untyped)'' |  ''null'' |   |
  
  
Line 124: Line 124:
 is_table_exists is_table_exists
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$link'' | ''(untyped)'' | //required// |  | +|  ''$link'' |  ''(untyped)'' |  //required// |   | 
-  | ''$table'' | ''(untyped)'' | //required// |  | +|  ''$table'' |  ''(untyped)'' |  //required// |   | 
-  | ''$counter'' | ''(untyped)'' | ''0'' |  |+|  ''$counter'' |  ''(untyped)'' |  ''0'' |   |
  
  
Line 138: Line 138:
 function check_dbtable function check_dbtable
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$link'' | ''(untyped)'' | //required// |  | +|  ''$link'' |  ''(untyped)'' |  //required// |   | 
-  | ''$table'' | ''(untyped)'' | //required// |  |+|  ''$table'' |  ''(untyped)'' |  //required// |   |
  
  
Line 151: Line 151:
 install_database_table() install_database_table()
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$link'' | ''(untyped)'' | //required// |  | +|  ''$link'' |  ''(untyped)'' |  //required// |   | 
-  | ''$protocol'' | ''(untyped)'' | //required// |  | +|  ''$protocol'' |  ''(untyped)'' |  //required// |   | 
-  | ''$server_host'' | ''(untyped)'' | //required// |  | +|  ''$server_host'' |  ''(untyped)'' |  //required// |   | 
-  | ''$user_login'' | ''(untyped)'' | //required// |  | +|  ''$user_login'' |  ''(untyped)'' |  //required// |   | 
-  | ''$user_pass'' | ''(untyped)'' | //required// |  | +|  ''$user_pass'' |  ''(untyped)'' |  //required// |   | 
-  | ''$user_email'' | ''(untyped)'' | //required// |  | +|  ''$user_email'' |  ''(untyped)'' |  //required// |   | 
-  | ''$key'' | ''(untyped)'' | //required// |  | +|  ''$key'' |  ''(untyped)'' |  //required// |   | 
-  | ''$prefix'' | ''(untyped)'' | '''''' |  | +|  ''$prefix'' |  ''(untyped)'' |  '''''' |   | 
-  | ''$site_language'' | ''(untyped)'' | '''en''' |  | +|  ''$site_language'' |  ''(untyped)'' |  '''en''' |   | 
-  | ''$defuse_key_path'' | ''(untyped)'' | '''''' |  | +|  ''$defuse_key_path'' |  ''(untyped)'' |  '''''' |   | 
-  | ''$dbhost'' | ''(untyped)'' | '''''' |  |+|  ''$dbhost'' |  ''(untyped)'' |  '''''' |   |
  
  
Line 173: Line 173:
 install_i18n_data() install_i18n_data()
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$link'' | ''(untyped)'' | //required// |  | +|  ''$link'' |  ''(untyped)'' |  //required// |   | 
-  | ''$prefix'' | ''(untyped)'' | '''''' |  | +|  ''$prefix'' |  ''(untyped)'' |  '''''' |   | 
-  | ''$default_lang'' | ''(untyped)'' | '''en''' | (language code to set as default) |+|  ''$default_lang'' |  ''(untyped)'' |  '''en''' |  (language code to set as default) |
  
  
Line 187: Line 187:
 install_privacy_policy_data() install_privacy_policy_data()
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$link'' | ''(untyped)'' | //required// |  | +|  ''$link'' |  ''(untyped)'' |  //required// |   | 
-  | ''$prefix'' | ''(untyped)'' | '''''' |  |+|  ''$prefix'' |  ''(untyped)'' |  '''''' |   |
  
  
Line 200: Line 200:
 grab_app_key() grab_app_key()
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$mysqli'' | ''(untyped)'' | //required// |  | +|  ''$mysqli'' |  ''(untyped)'' |  //required// |   | 
-  | ''$key'' | ''(untyped)'' | //required// |  | +|  ''$key'' |  ''(untyped)'' |  //required// |   | 
-  | ''$prefix'' | ''(untyped)'' | '''''' |  |+|  ''$prefix'' |  ''(untyped)'' |  '''''' |   |
  
  
Line 214: Line 214:
 update_app_key() update_app_key()
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$mysqli'' | ''(untyped)'' | //required// |  | +|  ''$mysqli'' |  ''(untyped)'' |  //required// |   | 
-  | ''$app_key'' | ''(untyped)'' | //required// |  | +|  ''$app_key'' |  ''(untyped)'' |  //required// |   | 
-  | ''$id'' | ''(untyped)'' | //required// |  | +|  ''$id'' |  ''(untyped)'' |  //required// |   | 
-  | ''$prefix'' | ''(untyped)'' | '''''' |  |+|  ''$prefix'' |  ''(untyped)'' |  '''''' |   |
  
  
Line 229: Line 229:
 write_config_file write_config_file
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$protocol'' | ''(untyped)'' | //required// |  | +|  ''$protocol'' |  ''(untyped)'' |  //required// |   | 
-  | ''$server_name'' | ''(untyped)'' | //required// |  | +|  ''$server_name'' |  ''(untyped)'' |  //required// |   | 
-  | ''$dbhost'' | ''(untyped)'' | //required// |  | +|  ''$dbhost'' |  ''(untyped)'' |  //required// |   | 
-  | ''$dbpassword'' | ''(untyped)'' | //required// |  | +|  ''$dbpassword'' |  ''(untyped)'' |  //required// |   | 
-  | ''$dbuser'' | ''(untyped)'' | //required// |  | +|  ''$dbuser'' |  ''(untyped)'' |  //required// |   | 
-  | ''$dbname'' | ''(untyped)'' | //required// |  | +|  ''$dbname'' |  ''(untyped)'' |  //required// |   | 
-  | ''$dbport'' | ''(untyped)'' | //required// |  | +|  ''$dbport'' |  ''(untyped)'' |  //required// |   | 
-  | ''$email'' | ''(untyped)'' | //required// |  | +|  ''$email'' |  ''(untyped)'' |  //required// |   | 
-  | ''$key'' | ''(untyped)'' | //required// |  | +|  ''$key'' |  ''(untyped)'' |  //required// |   | 
-  | ''$ca'' | ''(untyped)'' | //required// |  | +|  ''$ca'' |  ''(untyped)'' |  //required// |   | 
-  | ''$prefix'' | ''(untyped)'' | '''''' |  | +|  ''$prefix'' |  ''(untyped)'' |  '''''' |   | 
-  | ''$defuse_key_path_from_install'' | ''(untyped)'' | '''''' |  |+|  ''$defuse_key_path_from_install'' |  ''(untyped)'' |  '''''' |   |
  
  
Line 252: Line 252:
 Escape value for .env file format Escape value for .env file format
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$value'' | ''(untyped)'' | //required// |  |+|  ''$value'' |  ''(untyped)'' |  //required// |   |
  
  
Line 264: Line 264:
 Write .env file with environment variables Write .env file with environment variables
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$protocol'' | ''(untyped)'' | //required// |  | +|  ''$protocol'' |  ''(untyped)'' |  //required// |   | 
-  | ''$server_name'' | ''(untyped)'' | //required// |  | +|  ''$server_name'' |  ''(untyped)'' |  //required// |   | 
-  | ''$dbhost'' | ''(untyped)'' | //required// |  | +|  ''$dbhost'' |  ''(untyped)'' |  //required// |   | 
-  | ''$dbuser'' | ''(untyped)'' | //required// |  | +|  ''$dbuser'' |  ''(untyped)'' |  //required// |   | 
-  | ''$dbpass'' | ''(untyped)'' | //required// |  | +|  ''$dbpass'' |  ''(untyped)'' |  //required// |   | 
-  | ''$dbname'' | ''(untyped)'' | //required// |  | +|  ''$dbname'' |  ''(untyped)'' |  //required// |   | 
-  | ''$dbport'' | ''(untyped)'' | //required// |  | +|  ''$dbport'' |  ''(untyped)'' |  //required// |   | 
-  | ''$prefix'' | ''(untyped)'' | //required// |  | +|  ''$prefix'' |  ''(untyped)'' |  //required// |   | 
-  | ''$email'' | ''(untyped)'' | //required// |  | +|  ''$email'' |  ''(untyped)'' |  //required// |   | 
-  | ''$app_key'' | ''(untyped)'' | //required// |  | +|  ''$app_key'' |  ''(untyped)'' |  //required// |   | 
-  | ''$distro'' | ''(untyped)'' | //required// |  | +|  ''$distro'' |  ''(untyped)'' |  //required// |   | 
-  | ''$defuse_key_path'' | ''(untyped)'' | '''''' |  |+|  ''$defuse_key_path'' |  ''(untyped)'' |  '''''' |   |
  
  
Line 287: Line 287:
 remove_bad_characters() remove_bad_characters()
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$str_words'' | ''(untyped)'' | //required// |  | +|  ''$str_words'' |  ''(untyped)'' |  //required// |   | 
-  | ''$host'' | ''(untyped)'' | //required// |  | +|  ''$host'' |  ''(untyped)'' |  //required// |   | 
-  | ''$user'' | ''(untyped)'' | //required// |  | +|  ''$user'' |  ''(untyped)'' |  //required// |   | 
-  | ''$password'' | ''(untyped)'' | //required// |  | +|  ''$password'' |  ''(untyped)'' |  //required// |   | 
-  | ''$database'' | ''(untyped)'' | //required// |  | +|  ''$database'' |  ''(untyped)'' |  //required// |   | 
-  | ''$port'' | ''(untyped)'' | //required// |  | +|  ''$port'' |  ''(untyped)'' |  //required// |   | 
-  | ''$escape'' | ''(untyped)'' | ''false'' |  | +|  ''$escape'' |  ''(untyped)'' |  ''false'' |   | 
-  | ''$level'' | ''(untyped)'' | '''high''' |  |+|  ''$level'' |  ''(untyped)'' |  '''high''' |   |
  
  
Line 306: Line 306:
 Escape HTML Function Escape HTML Function
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$html'' | ''(untyped)'' | //required// |  |+|  ''$html'' |  ''(untyped)'' |  //required// |   |
  
  
Line 318: Line 318:
 installation_key installation_key
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$length'' | ''(untyped)'' | //required// |  |+|  ''$length'' |  ''(untyped)'' |  //required// |   |
  
  
Line 330: Line 330:
 convert_memory_used() convert_memory_used()
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$size'' | ''(untyped)'' | //required// |  |+|  ''$size'' |  ''(untyped)'' |  //required// |   |
  
  
Line 342: Line 342:
 setup_base_url() setup_base_url()
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$protocol'' | ''(untyped)'' | //required// |  | +|  ''$protocol'' |  ''(untyped)'' |  //required// |   | 
-  | ''$server_host'' | ''(untyped)'' | //required// |  |+|  ''$server_host'' |  ''(untyped)'' |  //required// |   |
  
  
Line 382: Line 382:
 genereate_table_prefix() genereate_table_prefix()
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$length'' | ''(untyped)'' | ''6'' |  |+|  ''$length'' |  ''(untyped)'' |  ''6'' |   |
  
  
scriptlog/install/setup.txt · Last modified: by admin