aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/INSTALL.md
blob: 8186383488977fff8ee0a795a5169af2d2d0db3b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
NOTE - this is the OpenSim 0.9.0.1 version in the SledjChisl branch,
which isn't quite ready yet.  Use 0.8.2.1 in the master branch for the
stable well tested version.


Use this to create a sim that links into Infinite Grid or Misfitz Grid
from Linux.

It's only been tested on Ubuntu 10.04, 11.04, 12.04, 16.04, as well as
Debian 8, and Devuan 9, YMMV.  This is also a WIP, use it at your own
risk.  It's been used to set up a few freshly installed servers though. 
It should work on recent Debian based Linux distros.


For those in a hurry.
---------------------

On a recent Debian based Linux (Debian, Devuan, Ubuntu, Mint, ...)
terminal, run the following command -

./InstallItAll.sh

This will install the prerequisites (MariaDB, monit, MONO, tmux,
uuid-runtime); create a database in MariaDB called opensim_SC and a
database user called opensim_SC with a random password; add a Linux user
to your system called opensimsc; create the /opt/opensim_SC directory to
run it all from; copy everything to /opt/opensim_SC/opensim-SC_0.9.0.1;
setup the directory structure needed to run it all; create some default
configuration files; build OpenSim-SC; and finally change ownership and
file permissions for everything.

You will likely need to login your user again, so you get the new group
assigned to it.  Otherwise the tmux stuff in start-sim might fail.

Next go to /opt/opensim_SC/current/scripts/install and run -

sudo ./create_sim.sh

This will create a randomly named sim at a randomly chosen position.  Or
for something less random -

sudo ./create_sim.sh "My new sim" "1234,5678"

At this point /opt/opensim_SC/config/config.ini will be a symlink
pointing to config_localhost.ini, which is for a standalone sim.  If you
want your new random sim to be part of Infinite Grid (IG) or Misfitz Grid
(MG) then you'll have to change that syml/ink to point to config_IG.ini or
config_MG.ini respectively.

/opt/opensim_SC/config/sim01 now contains the aactual configuration of
your randomly created sim.  Edit the .xml file to make that sim a little
less random.

Finally run -

cd /opt/opensim_SC/config/sim01
./start-sim

To actually startup your sim.  And if you want to see the console of your
sim run -

cd /opt/opensim_SC/current/scripts
./show-console


The directory layout.
---------------------

The various directories are -

.git		Used by git for it's internal accounting, and the older versions.

.nant		Used by the nant build tool.

OpenSim		OpenSim source code.

Prebuild	Used by the build system.

ThirdParty	For third party OpenSim modules.
ThirdPartyLicenses

addon-modules	Also for third party modules.  Don't ask me why there's two.

bin		The OpenSim binaries, and other files.

doc		Supposedly for documentation, which I wish OpenSim devs would write some.

example		An example of how to set this all up.

scripts		Various Linux scripts for managing OpenSim.

share		No idea really.

Also, the installation script copies the following directories from the
example directory, to outside of this main directory, they are all used
for writing various things.  Makes it easy to upgrade, and separates them
from actual executable stuff.

AssetFiles	Stores assets if running in grid mode.

backups		All sim and inventory backups are stored here.

caches		Various cached things.

config		All your configuration files.

db		If you are not using MySQL, your data lives here.

logs		Log files get stored here.


Follow these steps.
-------------------

Go to -

https://www.infinitegrid.org/drupal/content/How_to_link_your_OpenSim_region_to_Infinite_Grid_LinuxMySQL

and follow the directions to create an admin user account.  You can skip
that bit if you already have a suitable user with sudo access.

Note that these scripts pretty much follow that above wiki description,
with some exceptions.  The configuration information per sim has been
rearranged so that there is only ONE copy of the OpenSim installation.

Next you need to figure out what password you want to use for OpenSims
access to the database.  We will call this "DatabasePassword".  Run the
following script, from inside the OpenSim directory -

./InstallItAll.sh DatabasePassword

This will do most of the work for you, except for creating sims.


Creating sims.
--------------

A separate script is here for sim creation, you can use it to create many
sims.  You will need -

A name for your sim, we will use "My new sim".  It should be unique on
the grid.

Your host name, or it could be your IP, we will use "sims.example.net".

A location for your sim, we will use "1234,5678".  You can use the
Infinite Grid web based map to poke around and find a good location. 
Choose an empty spot.

Once you have all that information sorted out, run this script from the
scripts/install directory -

./create_sim.sh "My new sim" "1234,5678" "sims.example.net"

Or this if you want to override the detected IP address -

./create_sim.sh "My new sim" "1234,5678" "sims.example.net" "1.2.3.4"

Also, you can create a varregion with something like -

./create_sim.sh "My new sim" "1234,5678" "sims.example.net" "1.2.3.4" 512

Note that the size has to be a multiple of 256, so 512, 768, 1024, etc.

Running sims.
-------------

Now you can go to /opt/opensim/config/sim01 and run the following script
to start it up -

./start-sim

You will see the screen console.  You can run the screen console again by
running that command once more, or running the sim-console command.

You can stop the sim with -

./stop-sim

You can backup the sim with -

./backup-sim



Finishing up.
-------------

Once it's all tested, you can use this to finish things off (back in
the scripts directory) -

./go_live.sh

Which sets up the monit control file/s, though you should double check
it all, and you still have to do the basic configuration and enabling of
monit yourself.  This is in case you already have monit set the way you
like.


NOTES -

This attempts to use only one copy of the OS install for all sims.  We
are running one instance of OS for each sim though, as this prevents one
sim crashing from bringing down the others.  OS however really wants to
write data to directories within it's own bin directory.  I'm not at all
certain if that data can be shared.  For the same reason, so far I've
not been able to get to the point where we can make the OS directory
read only.  This complicates things during upgrades.