From 0b99483f0d934faf53228fad2169e4884241cb54 Mon Sep 17 00:00:00 2001 From: Roan Horning Date: Sat, 22 Oct 2022 21:11:57 -0400 Subject: [PATCH] Update installation instruction to include details for MySQL --- README.md | 25 +++++++++++++++++-------- site-generator | 24 ++++++++++++++++++------ 2 files changed, 35 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1bdf28f..39ab07d 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,22 @@ Static web page generator for the Hacker Public Radio website. ## Installation * Clone or download this repository -* Create the sqlite3 database from the files in the _sql directory. The default name for the database file is "hpr.db" and should be located in the root of the project directory. The name and location can be set in the site.cfg file. -* Two sql helper scripts are available to generate an empty database or a database filled with test data. - - For an empty database: `cat Create_Database_Empty.sql | sqlite3 hpr.db` - - For a database with test data: `cat Create_Database_Test.sql | sqlite3 hpr.db` -* SQLite v3.8.3 or greater is recommended. CTE WITH clauses are used in some template queries. Must convert WITH - clauses to sub-queries when using earlier versions of SQLite. +* With SQLite + * Create the sqlite3 database from the files in the _sql directory. The default name for the database file is "hpr.db" and should be located in the root of the project directory. The name and location can be set in the site.cfg file. + * Two sql helper scripts are available to generate an empty database or a database filled with test data. + - For an empty database: `cat Create_Database_Empty.sql | sqlite3 hpr.db` + - For a database with test data: `cat Create_Database_Test.sql | sqlite3 hpr.db` + * SQLite v3.8.3 or greater is recommended. CTE WITH clauses are used in some template queries. Must convert WITH + clauses to sub-queries when using earlier versions of SQLite. +* With MySQL + * Create database hpr_hpr in the MySQL server from HPR dump file. + - ``sudo mysql --host=localhost < hpr.sql`` + * Create a user that will be used by the site-generator. + - Suggested username: hpr-generator + - ``CREATE USER 'hpr-generator'@'localhost' IDENTIFIED BY '';`` + * Limit the user's privileges to EXECUTE and SELECT + - ``GRANT SELECT ON hpr_hpr.* TO 'hpr-generator'@'localhost';`` + - ``GRANT EXECUTE ON `hpr_hpr`.* TO 'hpr-generator'@'localhost';`` * Install the needed Perl modules using preferred method (distribution packages, CPAN, etc.) * GetOpt * Pod::Usage @@ -18,7 +28,7 @@ Static web page generator for the Hacker Public Radio website. * Template::Plugin::DBI * DBI * Tie::DBI - * DBD::SQLite + * DBD::SQLite or DBD:mysql * Date::Calc ## Usage @@ -50,4 +60,3 @@ and add the label "**Feature Request**". ## Authors and acknowledgment * Roan "Rho`n" Horning - diff --git a/site-generator b/site-generator index 86e52a7..3a59d65 100755 --- a/site-generator +++ b/site-generator @@ -35,15 +35,27 @@ This is a site generator for the Hacker Public Radio website based upon the Perl =head1 INSTALLATION + With SQLite * Create the sqlite3 database from the files in the _sql directory. The default name for the database file is "hpr.db" and should be located in the root of the project directory. The name and location can be set in the site.cfg file. * Two sql helper scripts are available to generate an empty database or a database filled with test data. - - For an empty database: `cat Create_Database_Empty.sql | sqlite3 hpr.db` - - For a database with test data: `cat Create_Database_Test.sql | sqlite3 hpr.db` - * SQLite v3.8.3 or greater is recommended. CTE WITH clauses are used in some template queries. Must convert WITH - clauses to sub-queries when using earlier versions of SQLite. - * Install the needed Perl modules using preferred method (distribution packages, CPAN, etc.) + - For an empty database: cat Create_Database_Empty.sql | sqlite3 hpr.db + - For a database with test data: cat Create_Database_Test.sql | sqlite3 hpr.db + * SQLite v3.8.3 or greater is recommended. CTE WITH clauses are used in some template queries. + Must convert WITH clauses to sub-queries when using earlier versions of SQLite. + + With MySQL + * Create database hpr_hpr in the MySQL server from HPR dump file. + - sudo mysql --host=localhost < hpr.sql + * Create a user that will be used by the site-generator. + - Suggested username: hpr-generator + - CREATE USER 'hpr-generator'@'localhost' IDENTIFIED BY ''; + * Limit the user's privileges to EXECUTE and SELECT + - GRANT SELECT ON hpr_hpr.* TO 'hpr-generator'@'localhost'; + - GRANT EXECUTE ON `hpr_hpr`.* TO 'hpr-generator'@'localhost'; + + Install the needed Perl modules using preferred method (distribution packages, CPAN, etc.) * GetOpt * Pod::Usage * Config::Std @@ -52,7 +64,7 @@ This is a site generator for the Hacker Public Radio website based upon the Perl * Template::Plugin::DBI * DBI * Tie::DBI - * DBD::SQLite + * DBD::SQLite or DBD:mysql * Date::Calc =head1 AUTHOR