Upgrading

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(→‎Example)
(→‎Related)
 
(28 intermediate revisions by one user not shown)
Line 4: Line 4:
 
= Updating your version of OpenSimulator =
 
= Updating your version of OpenSimulator =
  
−
Upgrading your version of OpenSimulator involves 2 major steps
+
<b>Always read the release notes of the new version. It may include more information for the update process</b>
  
−
1.  Updating your existing data for the new version of OpenSimulator.
+
Upgrading your version of OpenSimulator involves 4 major steps
  
−
2. Updating the config files for the new [[0.9.0.0_Release#Pivot_Release:_0.8.2.1]]version of OpenSimulator.
+
1. Backup current instalation, including databases.
  
−
NOTE: If you are upgrading from a version of OpenSimulator prior to 0.8.2.1, then you MUST first upgrade to *0.8.2.1* and then proceed to upgrade to 0.9.0.0. Full details can be found in the wiki page found at:<br /> http://opensimulator.org/wiki/0.9.0.0_Release#Pivot_Release:_0.8.2.1
+
2. Update the code
  
−
== Updating your existing data ==
+
3. Update your existing data for the new version of OpenSimulator.
  
−
The first step is very easy. OpenSimulator has a data migration system which will automatically update your old database schema and data for use with the new version of OpenSimulator.  This will be valid for many past versions of OpenSimulator (currently all the way back to OpenSimulator 0.6.9 and quite possibly before).
+
4. Update the configuration files.
  
−
Naturally, we very strongly recommend that you make a backup of your old database first, but the upgrade process almost always occurs without a hitch. However, one could always suffer a power cut or other major computer failure during the ugprade.
+
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're using SQLite, then you will also need to copy over the database files since these are in the OpenSimulator bin directory.  These will be all the files ending with .db (e.g. Asset.db, inventory.db).
+
  
−
Performing this upgrade means configuring your new OpenSimulator version to access your existing database. This brings us onto the next step.
+
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.
  
 
== Updating your config files ==
 
== Updating your config files ==
Line 27: Line 33:
 
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.
 
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 look through the new config files and copy over the settings that apply to both the new and old config.
+
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
  
−
This applies to both the main configuration files (e.g. OpenSim.ini and config-include/*.ini) and any region configuration files.
+
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
  
−
SEE Discussion at [[Talk:Upgrading]] for examples of How-To Back Up & Restore your system PRIOR to ANY Migration or Upgrade!
+
if have splited services, do this per each instance.
  
−
== Example ==
 
  
−
'''Region'''
+
SEE Discussion at [[Talk:Upgrading]] for examples of How-To Back Up & Restore your system PRIOR to ANY Migration or Upgrade!
−
+
−
1. Build the latest version from source (or download the binaries)
+
−
+
−
2. Put this new installation in a new folder
+
−
+
−
3. If using SQLite Copy the following files from the old \bin to the new \bin
+
−
    - All *.db files
+
−
+
−
4. Copy example configuration files
+
−
    bin/OpenSim.ini.example to bin/OpenSim.ini
+
−
    bin/Regions/Regions.ini.example to Regions.ini
+
−
    bin/config-include/*ini.example to bin/config-include/*.ini
+
−
 
+
−
5. Look through the configuration files and modify for your case, using the old ones as reference:
+
−
    The opensim.ini file
+
−
    The bin/config-include INI files
+
−
    The bin/Regions/Regions.ini files
+
−
    The bin/estate_settings.xml (if it has been amended)
+
−
+
−
6. Launch the new opensim by either:
+
−
    - run opensim.exe to run in windows native word size
+
−
    - run opensim32.exe to run in 32bit mode in windows 64bit
+
−
    - run opensim.sh in linux
+
−
 
+
−
TODO: Need to write example/instructions for migrating ROBUST.  This is actually a lot simpler - one just needs to copy over settings in Robust.ini as appropriate.
+
  
 
= Changing the database used by OpenSimulator =
 
= Changing the database used by OpenSimulator =
  
−
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).
+
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:
−
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.
+
  load oar HellIsland-021522.oar
−
 
+
if instance has several regions do not forget to change the console to the correct one:
−
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:
+
  change-region Private Hell
−
 
+
  load oar HellIsland-021522.oar
−
change-region My Island 1
+
−
  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.
+
  
−
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).
+
The change Robust databases is more a more complex issue, depending on the engines in question and their migration tools
  
 
= Related =
 
= Related =
  
−
[[Upgrade_Ubuntu_Standalone]] - OpenSimulator Upgrade notes for Ubuntu 8.10
+
[[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