Upgrading

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(→‎Related)
 
(41 intermediate revisions by 7 users not shown)
Line 2: Line 2:
 
<br />
 
<br />
  
−
== Migrating between versions of OpenSimulator without changing database backends ==
+
= Updating your version of OpenSimulator =
  
−
'''Unfortunately, this upgrading information is considerably out of date. We recommend that you do not attempt to copy over config files from previous versions of OpenSimulator but instead use the new files and make the changes by hand. However, it is possible to use previous version databases with new versions of OpenSimulator - on startup the data will automatically be migrated to the new formats (so it's best to make a database backup first in case this process goes wrong!).'''
+
<b>Always read the release notes of the new version. It may include more information for the update process</b>
  
−
Upgrading OpenSimulator so that your data stays intact is not too difficult. If you’re using MySQL or MSSQL as a backend database with standalone OpenSimulator then all you should have to do is copy over your bin/Regions xml files (and maybe your OpenSim.ini if you don’t want to re-enter your settings manually) to the new OpenSimulator version and start it.
+
Upgrading your version of OpenSimulator involves 4 major steps
  
−
If you're using grid mode then you will also need to copy the 5 xml files in the bin directory that govern the configuration of the UGAIM servers.  
+
1. Backup current instalation, including databases.
  
−
Note that estate_settings.xml if present is used for default values for estates, but the saved setttings themselves are in the data base "estate_settings" tables (since r5525).
+
2. Update the code
  
−
OpenSimulator contains code to automatically migrate all your data to conform to the newest formats. However, we would always suggest backing up your database beforehand in case something goes wrong during the conversion (e.g. you have a power cut).
+
3. Update your existing data for the new version of OpenSimulator.
  
−
Using sqlite (the default on disk database) is just a little more complicated. As well as copying bin/Regions and possibly OpenSim.ini, you also need to copy all the db files (AssetStorage.db, inventorystore.db, OpenSim.db and userprofile.db) to your new installation.
+
4. Update the configuration files.
  
−
This process should always work between the last numbered versions (e.g. going from 0.5.9 to 0.6.0). It may also work for older versions (e.g. 0.5.8 to 0.6.0) though this is not guaranteed.
+
If you have a old version, you may need to install and run intermediate versions, so that your data is automatically converted.
 +
For example to upgrade from a version prior to 0.8.2.1, then you MUST first upgrade to 0.8.2.1 and only then upgrade that to 0.9.0.0. Details for this case found at: http://opensimulator.org/wiki/0.9.0.0_Release#Pivot_Release:_0.8.2.1
  
−
SEE Discussion at [[Talk:Upgrading]] for examples of How-To Back Up & Restore your system PRIOR to ANY Migration or Upgrade!
+
== Update your existing data ==
  
−
'''METHOD 1: If Using SQLite in StandAlone Mode'''
+
If you use SQLite, copy *.db files of previous version bin folder to the new version bin folder. The old bin folder is the natural backup.
−
+
−
1. Build the latest version from source (or download the binaries)
+
−
+
−
2. Put this new installation in a new folder
+
−
+
−
3. Copy the following files from the old \bin to the new \bin
+
−
    - All *.db files
+
−
    - The opensim.ini file
+
−
    - The \bin\regions XML files
+
−
    - The \bin\config-include INI files
+
−
    - estate_settings.xml (if it has been amended)
+
−
+
−
4. Launch the new opensim.exe
+
  
−
'''METHOD 2: If Using MySQL in StandAlone Mode'''
+
In the case of the other database engines, the update of the data will happen automatically when running the new version, replacing the old data.
−
+
−
1. Build the latest version from source (or download the binaries)
+
−
+
−
2. Put this new installation in a new folder
+
−
+
−
3. Copy the following files from the old \bin to the new \bin
+
−
    - The opensim.ini file
+
−
    - The \bin\regions XML files
+
−
    - The \bin\config-include INI files
+
−
    - estate_settings.xml (if it has been amended)
+
−
+
−
4. Launch the new opensim.exe
+
  
−
'''METHOD 3: If Using MySQL in Grid Mode'''
+
If you do not backup the databases, so you will not be able to revert if something goes wrong
−
+
−
1. Build the latest version from source (or download the binaries)
+
−
+
−
2. Put this new installation in a new folder
+
−
+
−
3. Copy the following files from the old \bin to the new \bin
+
−
    - The opensim.ini file
+
−
    - The \bin\regions XML files
+
−
    - The 5 XML config files
+
−
    - The \bin\config-include INI files
+
−
    - estate_settings.xml (if it has been amended)
+
−
+
−
4. Launch services in the following order: UGAIM + R where "R" designates the region server (Opensim)
+
  
−
== Migrating databases ==
+
You should also backup the region saving a full oar of it.
  
−
Since SQLite is our default database, there often comes a time when people outgrow it and want to move on to another database backend (usually MySQL). There is a script on the forge at [http://forge.opensimulator.org/gf/project/sqlite2mysql/] which should be able to do the conversion. If it's out of date then just give the author/s a nudge (or patch it!)
+
== Updating your config files ==
 +
 
 +
This step is a little more involved.  We don't recommend that you simply copy over your existing config files to the new OpenSimulator installation.  Although this will often work, sometimes it's quite possible to miss new configuration settings which end up causing subtle and unexplained problems.
 +
 
 +
Instead, we strongly recommend that you copy the new example config files and change them to your case, using the old ones only as reference
 +
copy bin/OpenSim.ini.example to OpenSim.ini and edit.
 +
copy bin/Regions/Regions.ini.example to bin/Regions/Regions.ini
 +
copy bin/config-include/FlotsamCache.ini.example to bin/config-include/FlotsamCache.ini and edit (should not need)
 +
copy bin/config-include/osslEnable.ini.example to bin/config-include/osslEnable.ini and edit
 +
for standalones
 +
  copy bin/config-include/StandaloneCommon.ini.example to bin/config-include/StandaloneCommon and edit
 +
for grid regions
 +
  copy bin/config-include/GridCommon.ini.example to bin/config-include/GridCommon.ini and edit
 +
 
 +
if updating grid (robust) side
 +
with HG support
 +
  copy bin/Robust.HG.ini.example to bin Robust.HG.ini and edit
 +
without HG
 +
  copy bin/Robust.ini.example to bin Robust.ini and edit
 +
 
 +
if have splited services, do this per each instance.
 +
 
 +
 
 +
SEE Discussion at [[Talk:Upgrading]] for examples of How-To Back Up & Restore your system PRIOR to ANY Migration or Upgrade!
  
−
An alternative method is to change to each region (change-region) before backing up their contents to a separate OpenSimulator Region Archive (OAR) for each region. Then change the database backend and then reload the OARs in each region separately. The disadvantage of this is that it's a little laborious if you have many regions.
+
= Changing the database used by OpenSimulator =
  
−
You can use the "command-script" feature of OpenSim.exe to semi-automate this. E.g., create a file in your "bin" directory, called something like "dobackup", which contains the necessary commands, for example:
+
To change the database engine used by a region, for example for the simple SQLite to MySql, you will need a OpenSimulator Region Archive (OAR) file of the region, for example
 +
on a single region instance:
 +
load oar HellIsland-021522.oar
 +
if instance has several regions do not forget to change the console to the correct one:
 +
change-region Private Hell
 +
load oar HellIsland-021522.oar
  
−
change-region My Island 1
+
The change Robust databases is more a more complex issue, depending on the engines in question and their migration tools
−
save-oar MI1
+
−
change-region My Island 2
+
−
save-oar MI2
+
−
change-region Another Region
+
−
save-oar AR
+
−
change-region root
+
  
−
This can be run from OpenSim.exe by typing "command-script" followed by the name you gave the script (eg "dobackup"). Note that this will overwrite the previous backup of the same name.
+
= Related =
  
−
Note that using a save and reload via the OAR mechanism would not normally migrate your avatar inventories (you would need to rez everything out to the region, convert the data base, and then derez them again to your inventory).
+
[[Upgrade_Ubuntu_Standalone]] - OpenSimulator Upgrade notes for Ubuntu 8.10 (obsolete)

Latest revision as of 10:59, 15 February 2022

Languages Languages: 

En.png English   De.png Deutsch   Fr.png Français


Contents

[edit] Updating your version of OpenSimulator

Always read the release notes of the new version. It may include more information for the update process

Upgrading your version of OpenSimulator involves 4 major steps

1. Backup current instalation, including databases.

2. Update the code

3. Update your existing data for the new version of OpenSimulator.

4. Update the configuration files.

If you have a old version, you may need to install and run intermediate versions, so that your data is automatically converted. For example to upgrade from a version prior to 0.8.2.1, then you MUST first upgrade to 0.8.2.1 and only then upgrade that to 0.9.0.0. Details for this case found at: http://opensimulator.org/wiki/0.9.0.0_Release#Pivot_Release:_0.8.2.1

[edit] Update your existing data

If you use SQLite, copy *.db files of previous version bin folder to the new version bin folder. The old bin folder is the natural backup.

In the case of the other database engines, the update of the data will happen automatically when running the new version, replacing the old data.

If you do not backup the databases, so you will not be able to revert if something goes wrong

You should also backup the region saving a full oar of it.

[edit] Updating your config files

This step is a little more involved. We don't recommend that you simply copy over your existing config files to the new OpenSimulator installation. Although this will often work, sometimes it's quite possible to miss new configuration settings which end up causing subtle and unexplained problems.

Instead, we strongly recommend that you copy the new example config files and change them to your case, using the old ones only as reference 

copy bin/OpenSim.ini.example to OpenSim.ini and edit.
copy bin/Regions/Regions.ini.example to bin/Regions/Regions.ini
copy bin/config-include/FlotsamCache.ini.example to bin/config-include/FlotsamCache.ini and edit (should not need)
copy bin/config-include/osslEnable.ini.example to bin/config-include/osslEnable.ini and edit
for standalones
 copy bin/config-include/StandaloneCommon.ini.example to bin/config-include/StandaloneCommon and edit
for grid regions
 copy bin/config-include/GridCommon.ini.example to bin/config-include/GridCommon.ini and edit

if updating grid (robust) side 

with HG support
 copy bin/Robust.HG.ini.example to bin Robust.HG.ini and edit
without HG
 copy bin/Robust.ini.example to bin Robust.ini and edit

if have splited services, do this per each instance.


SEE Discussion at Talk:Upgrading for examples of How-To Back Up & Restore your system PRIOR to ANY Migration or Upgrade!

[edit] Changing the database used by OpenSimulator

To change the database engine used by a region, for example for the simple SQLite to MySql, you will need a OpenSimulator Region Archive (OAR) file of the region, for example on a single region instance: 

load oar HellIsland-021522.oar

if instance has several regions do not forget to change the console to the correct one: 

change-region Private Hell
load oar HellIsland-021522.oar

The change Robust databases is more a more complex issue, depending on the engines in question and their migration tools

[edit] Related

Upgrade_Ubuntu_Standalone - OpenSimulator Upgrade notes for Ubuntu 8.10 (obsolete)

Retrieved from "http://opensimulator.org/index.php?title=Upgrading&oldid=52109"
Personal tools
General
About This Wiki