aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/INSTALL.md
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md118
1 files changed, 66 insertions, 52 deletions
diff --git a/INSTALL.md b/INSTALL.md
index 6b0d234..40bf35b 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,15 +1,10 @@
1NOTE - this is the OpenSim 0.9.0.1 version in the SledjChisl branch, 1Use this to create a sim that links into IG or MG grids from Linux. Or
2which isn't quite ready yet. Use 0.8.2.1 in the master branch for the 2to run your own grid.
3stable well tested version.
4
5
6Use this to create a sim that links into Infinite Grid or Misfitz Grid
7from Linux.
8 3
9It's only been tested on Ubuntu 10.04, 11.04, 12.04, 16.04, as well as 4It's only been tested on Ubuntu 10.04, 11.04, 12.04, 16.04, as well as
10Debian 8, and Devuan 9, YMMV. This is also a WIP, use it at your own 5Debian 8, Devuan 9, and Devuan 9. YMMV. This is also a WIP, use it at
11risk. It's been used to set up a few freshly installed servers though. 6your own risk. It's been used to set up a few freshly installed servers
12It should work on recent Debian based Linux distros. 7though. It should work on recent Debian based Linux distros.
13 8
14You may want to use the latest Mono, you can get it by following the 9You may want to use the latest Mono, you can get it by following the
15instructions at - 10instructions at -
@@ -28,11 +23,11 @@ terminal, run the following command -
28This will install the prerequisites (MariaDB, monit, MONO, tmux, 23This will install the prerequisites (MariaDB, monit, MONO, tmux,
29uuid-runtime); create a database in MariaDB called opensim_SC and a 24uuid-runtime); create a database in MariaDB called opensim_SC and a
30database user called opensim_SC with a random password; add a Linux user 25database user called opensim_SC with a random password; add a Linux user
31to your system called opensimsc; create the /opt/opensim_SC directory to 26and group to your system called opensimsc; create the /opt/opensim_SC
32run it all from; copy everything to /opt/opensim_SC/opensim-SC_0.9.0.1; 27directory to run it all from; copy everything to
33setup the directory structure needed to run it all; create some default 28/opt/opensim_SC/opensim-SC_0.9.0.1; setup the directory structure needed
34configuration files; build OpenSim-SC; and finally change ownership and 29to run it all; create some default configuration files; build opensim-SC;
35file permissions for everything. 30and finally change ownership and file permissions for everything.
36 31
37You will likely need to login your user again, so you get the new group 32You will likely need to login your user again, so you get the new group
38assigned to it. Otherwise the tmux stuff in start-sim might fail. 33assigned to it. Otherwise the tmux stuff in start-sim might fail.
@@ -48,21 +43,26 @@ sudo ./create_sim.sh "My new sim" "1234,5678"
48 43
49At this point /opt/opensim_SC/config/config.ini will be a symlink 44At this point /opt/opensim_SC/config/config.ini will be a symlink
50pointing to config_localhost.ini, which is for a standalone sim. If you 45pointing to config_localhost.ini, which is for a standalone sim. If you
51want your new random sim to be part of Infinite Grid (IG) or Misfitz Grid 46want your new random sim to be part of IG or MG grids then you'll have to
52(MG) then you'll have to change that syml/ink to point to config_IG.ini or 47change that syml/ink to point to config_IG.ini or config_MG.ini
53config_MG.ini respectively. 48respectively. There is no point doing that unless you are a member of
49those grids.
54 50
55/opt/opensim_SC/config/sim01 now contains the actual configuration of 51/opt/opensim_SC/config/sim01 now contains the actual configuration of
56your randomly created sim. Edit the .ini file to make that sim a little 52your randomly created sim. Edit the .ini file to make that sim a little
57less random. 53less random. You can even rename the .ini file to match your sim name.
54
55If you are running a grid run -
58 56
59Finally run - 57cd /opt/opensim_SC/config/ROBUSH
58./start-sim
59
60Then to actually startup your sim -
60 61
61cd /opt/opensim_SC/config/sim01 62cd /opt/opensim_SC/config/sim01
62./start-sim 63./start-sim
63 64
64To actually startup your sim. And if you want to see the console of your 65And if you want to see the console of your sim run -
65sim run -
66 66
67cd /opt/opensim_SC/current/scripts 67cd /opt/opensim_SC/current/scripts
68./show-console 68./show-console
@@ -75,7 +75,7 @@ The various directories are -
75 75
76.git Used by git for it's internal accounting, and the older versions. 76.git Used by git for it's internal accounting, and the older versions.
77 77
78.nant Used by the nant build tool. 78.nant Used by the obsolete nant build tool.
79 79
80OpenSim OpenSim source code. 80OpenSim OpenSim source code.
81 81
@@ -113,20 +113,13 @@ db If you are not using MySQL, your data lives here.
113 113
114logs Log files get stored here. 114logs Log files get stored here.
115 115
116web Web files go here. You can edit them to change the background image for example.
117
116 118
117Follow these steps. 119Follow these steps.
118------------------- 120-------------------
119 121
120Go to - 122First you need to have a user on your computer with sudo access.
121
122https://www.infinitegrid.org/drupal/content/How_to_link_your_OpenSim_region_to_Infinite_Grid_LinuxMySQL
123
124and follow the directions to create an admin user account. You can skip
125that bit if you already have a suitable user with sudo access.
126
127Note that these scripts pretty much follow that above wiki description,
128with some exceptions. The configuration information per sim has been
129rearranged so that there is only ONE copy of the OpenSim installation.
130 123
131Next you need to figure out what password you want to use for OpenSims 124Next you need to figure out what password you want to use for OpenSims
132access to the database. We will call this "DatabasePassword". Run the 125access to the database. We will call this "DatabasePassword". Run the
@@ -146,37 +139,45 @@ sims. You will need -
146A name for your sim, we will use "My new sim". It should be unique on 139A name for your sim, we will use "My new sim". It should be unique on
147the grid. 140the grid.
148 141
149Your host name, or it could be your IP, we will use "sims.example.net". 142A location for your sim, we will use "1234,5678". Choose an empty spot.
150
151A location for your sim, we will use "1234,5678". You can use the
152Infinite Grid web based map to poke around and find a good location.
153Choose an empty spot.
154 143
155Once you have all that information sorted out, run this script from the 144Once you have all that information sorted out, run this script from the
156scripts/install directory - 145scripts/install directory -
157 146
158./create_sim.sh "My new sim" "1234,5678" "sims.example.net" 147./create_sim.sh "My new sim" "1234,5678" "sims.example.net"
159 148
160Or this if you want to override the detected IP address - 149Also, you can create a varregion with something like -
161 150
162./create_sim.sh "My new sim" "1234,5678" "sims.example.net" "1.2.3.4" 151./create_sim.sh "My new sim" "1234,5678" 512
163 152
164Also, you can create a varregion with something like - 153Note that the size has to be a multiple of 256, so 512, 768, 1024, etc.
1548096 is the maximum size, 2048 is about the biggest that is decently
155manageable.
165 156
166./create_sim.sh "My new sim" "1234,5678" "sims.example.net" "1.2.3.4" 512
167 157
168Note that the size has to be a multiple of 256, so 512, 768, 1024, etc. 158Running ROBUST.
159---------------
160
161If you are running your own grid, you need to start up ROBUST, which is
162a bunch of common services sims use. Go to /opt/opensim_SC/config/ROBUST
163and run the following script to start it up -
164
165./start-sim
166
167You will see the tmux console. You can run the tmux console again by
168running that command once more, or running the show-console script.
169
169 170
170Running sims. 171Running sims.
171------------- 172-------------
172 173
173Now you can go to /opt/opensim/config/sim01 and run the following script 174Now you can go to /opt/opensim_SC/config/sim01 and run the following script
174to start it up - 175to start it up -
175 176
176./start-sim 177./start-sim
177 178
178You will see the screen console. You can run the screen console again by 179You will see the tmux console. You can run the tmux console again by
179running that command once more, or running the sim-console command. 180running that command once more, or running the show-console script.
180 181
181You can stop the sim with - 182You can stop the sim with -
182 183
@@ -187,12 +188,23 @@ You can backup the sim with -
187./backup-sim 188./backup-sim
188 189
189 190
191Running it all at once.
192-----------------------
193
194You don't have to run ROBUST, then each sim, you can run the lot at once.
195Go to /opt/opensim_SC/current/scripts and run -
196
197./start-sim
198
199It'll wait a minute between sims to give things time to settle down, and
200not over work your computer.
201
190 202
191Finishing up. 203Finishing up.
192------------- 204-------------
193 205
194Once it's all tested, you can use this to finish things off (back in 206Once it's all tested, you can use this to finish things off (back in
195the scripts directory) - 207the /opt/opensim_SC/current/scripts directory) -
196 208
197./go_live.sh 209./go_live.sh
198 210
@@ -201,14 +213,16 @@ it all, and you still have to do the basic configuration and enabling of
201monit yourself. This is in case you already have monit set the way you 213monit yourself. This is in case you already have monit set the way you
202like. 214like.
203 215
216This step is entirely optional, and some versions of monit might not work
217so well.
218
204 219
205NOTES - 220NOTES -
206 221
207This attempts to use only one copy of the OS install for all sims. We 222This attempts to use only one copy of the OS install for all sims. We
208are running one instance of OS for each sim though, as this prevents one 223are running one instance of OS for each sim though, as this prevents one
209sim crashing from bringing down the others. OS however really wants to 224sim crashing from bringing down the others. OS however really wants to
210write data to directories within it's own bin directory. I'm not at all 225write data to directories within it's own bin directory. The preferred
211certain if that data can be shared. For the same reason, so far I've 226way to update opensim-SC is to download a fresh copy, run BuildIt.sh,
212not been able to get to the point where we can make the OS directory 227delete the installed copy, then copy this new one to where the old one
213read only. This complicates things during upgrades. 228used to be. I'll write an update script in the next version.
214