Repair settings.php: Difference between revisions From Online Manual

Jump to: navigation, search
No edit summary
m (Reverted edits by Illori (talk) to last revision by Chainy)
Tag: Rollback
 
(63 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{Cleanup html}}
{{Other languages}}
{{TOCright}}
<translate>
<!--T:1-->
The Repair Settings Tool (''repair_settings.php'') can be used to repair some of the most crucial settings on your forum, such as [[database|database]] information, file paths, and URLs. The tool can be used to repair an SMF installation sufficiently enough so that an [[administrator]] can then log in and fix any other problems.


'''<abbr title="Download repair_settings.php">[http://download.simplemachines.org/index.php?thanks;filename=repair_settings.php repair_settings.php]</abbr>''' is one of the most important tools for use with SMF. It allows you to change the most important settings such as MySQL information, file paths and urls, and can be used when SMF is not working at all. That is what it is mostly used for: repairing your SMF enough so that an admin user can login and fix any other problems.
<!--T:2-->
'''Backup first!''' - Using this tool should not cause any problems, but it is always better to make a [[backup]], just in case.


Using repair_settings.php is easy: simply upload the file to the root directory of your forum with FTP and then access the page in your browser. Once you have finished, remember to delete the file or else you will leave your forum vulnerable!
==Download the Repair Settings Tool== <!--T:16-->


''This tool can repair the following settings:''
<!--T:17-->
You can download the Repair Settings Tool (''repair_settings.php'') from the tools section of the SMF Downloads center: [http://download.simplemachines.org/index.php?thanks;filename=repair_settings.php repair_settings.php].


<ul class="bbc_list" style="list-style-type: decimal;"><li>'''Critical Settings'''
==Using the Repair Settings Tool== <!--T:18-->
<ul class="bbc_list"><li>Maintenance Mode - You can turn maintenance mode on your forum on and off and also make it completely unusable.</li><li>Language File - Change the language of your forum.</li><li>Cookie Name - Change the name of the cookie that your forum creates for the user&#039;s browsers.</li><li>Queryless URLs - Turn the use of queries in the forum&#039;s urls on and off.</li><li>Output Compression - Can turn output compression on and off.</li><li>Database driven sessions - Can set whether sessions are managed by the database or not.</li></ul></li><li>'''MySQL Settings:'''
<ul class="bbc_list"><li>Includes all of the typical settings that are needed to connect to the database; MySQL server address, MySQL database name, MySQL username, MySQL password, and MySQL table prefix.</li><li>MySQL connection type - Can be set to Persistent or Standard.</li></ul></li><li>'''Paths &amp; URLs'''
<ul class="bbc_list"><li>Allows you set set the paths for; Forum URL, Forum Directory, Sources Directory, Attachment Directory, Avatar URL, Avatar Directory, Smileys URL, Smileys Directory, Default Theme URL, Default Theme Images URL, and Default Theme Directory.</li></ul></li></ul>
'''Recommended values'''
In most cases, SMF can detect the correct value for each of the fields and settings. Underneath many of the settings is a link with with the recommended value. Clicking these links will update the corresponding textbox fields with the recommended value. Be careful though, because SMF will not always guess correctly if the server is configured unusually.


[[Category:Tools]]
<!--T:3-->
Upload the file ''repair_settings.php'' with an [[FTP_-_How_do_I_use_FTP|FTP client]] to the root directory of your forum  (where ''Settings.php'' can be found). Navigate with your browser to your usual forum URL, but instead of ''yoursitename/index.php'', direct your browser to ''yoursitename/repair_settings.php''.
 
<!--T:19-->
For example, if your forum is in the root directory of your site, and your site is at ''<nowiki>www.example.com</nowiki>'' you need to go to: ''<nowiki>http://www.example.com/repair_settings.php</nowiki>''. If it is located in a sub-directory named, for example ''forum'', you need to go to: ''<nowiki>http://www.example.com/forum/repair_settings.php</nowiki>''.
 
<!--T:15-->
'''ATTENTION:''' The ''repair_settings.php'' tool displays sensitive information about your server setup, namely the database user and password. Make sure that you delete it once you have finished the maintenance!
 
==Settings that can be repaired== <!--T:5-->
 
<!--T:6-->
In most cases, the Repair Settings Tool can detect the correct value for each of the fields and settings listed below. The tool will display a link under each item with a recommended value; clicking these links will update the corresponding text box fields with the recommended value. If you want the recommended value to be used for all of the settings on the page, scroll down to the bottom of the page and click on the link ''Restore all settings''. Be careful though, because SMF will not always guess the values correctly if the server is configured unusually.
 
===Critical Settings=== <!--T:7-->
 
<!--T:8-->
* '''Maintenance Mode''' - You can choose to turn [[maintenance mode]] on or off for your forum, and it is also possible to make your forum completely unusable (inaccessible even to administrators).
* '''Language File''' - This changes the language of your forum.</translate>
<translate>
<!--T:20-->
* '''Cookie Name''' - This changes the name of the [[Settings.php#.24cookiename|cookie]] that your forum creates for the user's browser.
* '''Queryless URLs''' - Turns the use of queries in the forum's URLs on and off (''../index.php/topic,1.0.html'' compared to ''../index.php?topic=1.0''). In the Admin Center, this setting is referred to as [[SMF2.0:Features_and_Options#General|Search engine friendly URLs]].</translate>
<translate>
<!--T:21-->
* '''Output Compression''' - Turns output compression on and off.
* '''Database driven sessions''' - Sets whether sessions are managed by the database.
*'''Set SMF default theme as overall forum default for all users''' - This will override the [[Profile#Look_and_Layout|theme preference]] in the profiles of all users.
 
===Database Settings=== <!--T:9-->
 
<!--T:22-->
This section includes all of the typical settings that are needed to connect to the [[database]] of your forum:
 
<!--T:23-->
*'''Server'''
*'''Database name'''
*'''Username'''
*'''Password'''
</translate>
{{ {{Localized|Version specific}}|small=yes|version=2.0+|content=
<translate>
<!--T:24-->
*'''SSI Username''' (optional)
*'''SSI Password''' (optional)</translate>}}
<translate>
<!--T:25-->
*'''Table prefix'''
*'''Connection Type''' (''Standard'' or ''Persistent'')
 
<!--T:26-->
If you are unsure about any of the above settings, please contact your host.
 
===Paths & URLs=== <!--T:10-->
 
<!--T:27-->
In this section, you can check that the directory paths and URLs are set correctly for your forum:
 
<!--T:28-->
*'''Forum URL'''
*'''Forum Directory'''
*'''Sources Directory'''
</translate>
{{ {{Localized|Version specific}}|small=yes|version=2.0+|content=
<translate>
<!--T:29-->
*'''Cache Directory'''</translate>}}
<translate>
<!--T:30-->
*'''Attachment Directory'''
*'''Avatar URL'''</translate>
<translate>
<!--T:31-->
*'''Avatar Directory'''
*'''Smileys URL'''
*'''Smileys Directory'''
 
<!--T:32-->
For more information on each of the settings above, please see [[Server settings]].
 
===Paths & URLs for Themes=== <!--T:33-->
 
<!--T:34-->
This section enables you to check that the directory paths and URLs are correct for the default theme as well as for any other themes that you have installed.
 
<!--T:11-->
The Repair Settings Tool will allow you to keep your custom theme as default and not reset to the default theme, unless you select the option ''Set SMF default theme as overall forum default for all users'', which is found in the [[Repair_settings.php#Critical_Settings|Critical Settings]] as mentioned above.
 
==Options== <!--T:12-->
 
<!--T:35-->
The following options appear at the bottom of the page when using the Repair Settings Tool:
 
<!--T:36-->
*'''Restore all settings''' - This changes all the settings to the ''recommended values'', which saves you the effort of clicking on each individual link for the recommended values (as found below each setting). As mentioned above, there is no guarantee that the tool will detect all of the correct settings, so you should use this button with caution.
</translate>
{{ {{Localized|Version specific}}|small=yes|version=2.0+|content=
<translate>
<!--T:37-->
*'''Remove all hooks''' - If [[Modification_(term)|mods]] have installed [[Integration hooks|hooks]] and a clean install is desired, clicking ''Remove all hooks'' will ensure that all mods have all elements removed/disabled. Do not use this button unless you know what you are doing.</translate>}}
<translate>
<!--T:38-->
*'''Remove this file. Careful, it may not work in all servers!''' - If you click this button, the tool will attempt to delete the file ''repair_settings.php'' in the root directory of your SMF installation. This is for security reasons. You might have to delete the file manually with your FTP client, though.
*'''Save Settings''' - Don't forget to click on this button in order to save the changes that you have made.
 
==Important Note== <!--T:14-->
 
<!--T:39-->
If you are using a different set of database details (perhaps due to moving your forum, or because you are trying to set up a secondary or test forum), make sure you use the Repair Settings Tool in the following order:
 
<!--T:40-->
#Run the Repair Settings Tool and make changes <u>only</u> in the database section. You must save the updated database settings ''before'' you do anything else.
#Run the Repair Settings Tool again. Now you can adjust the directory paths and URLs for your forum.
 
<!--T:41-->
It is important to use the tool in the above order because some of the directory paths and URLs (such as those for attachments, avatars, and smileys) are stored in the database. This means that if you attempt to change these paths and URLs before you have reset your forum to use the new database, you will in fact be making changes to the old forum database.
</translate>
[[Category:FAQ{{Langcat|{{BASEPAGENAME}}}}]]

Latest revision as of 09:34, 12 May 2023

Languages English  · español · italiano

The Repair Settings Tool (repair_settings.php) can be used to repair some of the most crucial settings on your forum, such as database information, file paths, and URLs. The tool can be used to repair an SMF installation sufficiently enough so that an administrator can then log in and fix any other problems.

Backup first! - Using this tool should not cause any problems, but it is always better to make a backup, just in case.

Download the Repair Settings Tool

You can download the Repair Settings Tool (repair_settings.php) from the tools section of the SMF Downloads center: repair_settings.php.

Using the Repair Settings Tool

Upload the file repair_settings.php with an FTP client to the root directory of your forum (where Settings.php can be found). Navigate with your browser to your usual forum URL, but instead of yoursitename/index.php, direct your browser to yoursitename/repair_settings.php.

For example, if your forum is in the root directory of your site, and your site is at www.example.com you need to go to: http://www.example.com/repair_settings.php. If it is located in a sub-directory named, for example forum, you need to go to: http://www.example.com/forum/repair_settings.php.

ATTENTION: The repair_settings.php tool displays sensitive information about your server setup, namely the database user and password. Make sure that you delete it once you have finished the maintenance!

Settings that can be repaired

In most cases, the Repair Settings Tool can detect the correct value for each of the fields and settings listed below. The tool will display a link under each item with a recommended value; clicking these links will update the corresponding text box fields with the recommended value. If you want the recommended value to be used for all of the settings on the page, scroll down to the bottom of the page and click on the link Restore all settings. Be careful though, because SMF will not always guess the values correctly if the server is configured unusually.

Critical Settings

  • Maintenance Mode - You can choose to turn maintenance mode on or off for your forum, and it is also possible to make your forum completely unusable (inaccessible even to administrators).
  • Language File - This changes the language of your forum.
  • Cookie Name - This changes the name of the cookie that your forum creates for the user's browser.
  • Queryless URLs - Turns the use of queries in the forum's URLs on and off (../index.php/topic,1.0.html compared to ../index.php?topic=1.0). In the Admin Center, this setting is referred to as Search engine friendly URLs.
  • Output Compression - Turns output compression on and off.
  • Database driven sessions - Sets whether sessions are managed by the database.
  • Set SMF default theme as overall forum default for all users - This will override the theme preference in the profiles of all users.

Database Settings

This section includes all of the typical settings that are needed to connect to the database of your forum:

  • Server
  • Database name
  • Username
  • Password
The following applies only to version 2.0+
  • SSI Username (optional)
  • SSI Password (optional)
  • Table prefix
  • Connection Type (Standard or Persistent)

If you are unsure about any of the above settings, please contact your host.

Paths & URLs

In this section, you can check that the directory paths and URLs are set correctly for your forum:

  • Forum URL
  • Forum Directory
  • Sources Directory
The following applies only to version 2.0+
  • Cache Directory
  • Attachment Directory
  • Avatar URL
  • Avatar Directory
  • Smileys URL
  • Smileys Directory

For more information on each of the settings above, please see Server settings.

Paths & URLs for Themes

This section enables you to check that the directory paths and URLs are correct for the default theme as well as for any other themes that you have installed.

The Repair Settings Tool will allow you to keep your custom theme as default and not reset to the default theme, unless you select the option Set SMF default theme as overall forum default for all users, which is found in the Critical Settings as mentioned above.

Options

The following options appear at the bottom of the page when using the Repair Settings Tool:

  • Restore all settings - This changes all the settings to the recommended values, which saves you the effort of clicking on each individual link for the recommended values (as found below each setting). As mentioned above, there is no guarantee that the tool will detect all of the correct settings, so you should use this button with caution.
The following applies only to version 2.0+
  • Remove all hooks - If mods have installed hooks and a clean install is desired, clicking Remove all hooks will ensure that all mods have all elements removed/disabled. Do not use this button unless you know what you are doing.
  • Remove this file. Careful, it may not work in all servers! - If you click this button, the tool will attempt to delete the file repair_settings.php in the root directory of your SMF installation. This is for security reasons. You might have to delete the file manually with your FTP client, though.
  • Save Settings - Don't forget to click on this button in order to save the changes that you have made.

Important Note

If you are using a different set of database details (perhaps due to moving your forum, or because you are trying to set up a secondary or test forum), make sure you use the Repair Settings Tool in the following order:

  1. Run the Repair Settings Tool and make changes only in the database section. You must save the updated database settings before you do anything else.
  2. Run the Repair Settings Tool again. Now you can adjust the directory paths and URLs for your forum.

It is important to use the tool in the above order because some of the directory paths and URLs (such as those for attachments, avatars, and smileys) are stored in the database. This means that if you attempt to change these paths and URLs before you have reset your forum to use the new database, you will in fact be making changes to the old forum database.

Retrieved from "https://wiki.simplemachines.org/w/index.php?title=Repair_settings.php&oldid=31782"


Advertisement: