Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Expanded README

  • Loading branch information...
commit 22aa240de881bd7334931bf89b1d9611d55b3a4f 1 parent 25a5f31
Major Hayden authored September 16, 2009

Showing 1 changed file with 55 additions and 1 deletion. Show diff stats Hide diff stats

  1. 56  README
56  README
@@ -2,8 +2,28 @@
2 2
 
3 3
 MySQLTuner is a script written in Perl that allows you to review a MySQL installation quickly and make adjustments to increase performance and stability.  The current configuration variables and status data is retrieved and presented in a brief format along with some basic performance suggestions.
4 4
 
  5
+Compatibility:
  6
+	* MySQL 3.23, 4.0, 4.1, 5.0, 5.1 (full support)
  7
+	* MySQL 5.4 (not fully tested, partially supported)
  8
+	* MySQL 6.0 (partial support)
  9
+	* Perl 5.6 or later
  10
+	* Unix/Linux based operating system (tested on Linux, BSD variants, and Solaris variants)
  11
+	* Windows is not supported at this time
  12
+	* Unrestricted read access to the MySQL server (OS root access recommended for MySQL < 5.0)
  13
+
  14
+Please review the FAQ section below.
  15
+
  16
+*WARNING*
  17
+	It is extremely important for you to fully understand each change 
  18
+	you make to a MySQL database server.  If you don't understand portions 
  19
+	of the script's output, or if you don't understand the recommendations, 
  20
+	you should consult a knowledgeable DBA or even a system administrator 
  21
+	that you trust.  Always test your changes on staging environments, and 
  22
+	always keep in mind that improvements in one area can negatively affect 
  23
+	MySQL in other areas.
  24
+
  25
+	Seriously - please review the FAQ section below.
5 26
 *WARNING*
6  
-It is extremely important for you to fully understand each change you make to a MySQL database server.  If you don't understand portions of the script's output, or if you don't understand the recommendations, you should consult a knowledgeable DBA or even a system administrator that you trust.  Always test your changes on staging environments, and always keep in mind that improvements in one area can negatively affect MySQL in other areas.
7 27
 
8 28
 ----- Download/Installation -----
9 29
 
@@ -14,3 +34,37 @@ You can download the entire repository by using 'git clone' followed by the clon
14 34
 	
15 35
 Of course, you can add the execute bit (chmod +x mysqltuner.pl) so you can execute it without calling perl directly.
16 36
 
  37
+----- FAQ -----
  38
+
  39
+Question: Will MySQLTuner fix my slow MySQL server?
  40
+
  41
+Literally - no.  MySQLTuner is a read only script.  It won't write to any configuration files, change the status of any daemons, or call your mother to wish her a happy birthday.  It will give you an overview of your server's performance and make some basic recommendations about improvements that you can make after it completes.  Make sure you read the warning above prior to following any recommendations.
  42
+
  43
+Question: Can I fire my DBA now?
  44
+
  45
+MySQLTuner will not replace your DBA in any form or fashion.  If your DBA constantly takes your parking spot and steals your lunch from the fridge, then you may want to consider it - but that's your call.
  46
+
  47
+Question: Why does MySQLTuner keep asking me the login credentials for MySQL over and over?
  48
+
  49
+The script will try its best to log in via any means possible.  It will check for ~/.my.cnf files, Plesk password files, and empty password root logins.  If none of those are available, then you'll be prompted for a password.  If you'd like the script to run in an automated fashion without user intervention, then create a .my.cnf file in your home directory which contains:
  50
+
  51
+	[client]
  52
+	user=someusername
  53
+	pass=thatuserspassword
  54
+	
  55
+Once you create it, make sure it's owned by your user and the mode on the file is 0600.  This should prevent the prying eyes from getting your database login credentials under normal conditions.  If a T-1000 shows up in a LAPD uniform and demands your database credentials, you won't have much of an option.
  56
+
  57
+Question: It's not working on my OS! What gives?!
  58
+
  59
+These kinds of things are bound to happen.  Here are the details I need from you in order to research the problem thoroughly:
  60
+
  61
+	* OS and OS version
  62
+	* Architecture (x86, x86_64, IA64, Commodore 64)
  63
+	* Exact MySQL version
  64
+	* Where you obtained your MySQL version (OS package, source, etc)
  65
+	* The full text of the error
  66
+	* A copy of SHOW VARIABLES and SHOW GLOBAL STATUS output (if possible)
  67
+
  68
+Once you get those, join the Google Group and drop your issue to the list:
  69
+
  70
+	http://groups.google.com/group/mysqltuner-talk

0 notes on commit 22aa240

Please sign in to comment.
Something went wrong with that request. Please try again.