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