aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authoronefang2019-09-11 16:36:50 +1000
committeronefang2019-09-11 16:36:50 +1000
commit50cd1ffd32f69228e566f2b0b89f86ea0d9fe489 (patch)
tree52f2ab0c04f1a5d7d6ac5dc872981b4b156447e7 /README.md
parentRenamed branch to SledjChisl. (diff)
parentBump to release flavour, build 0. (diff)
downloadopensim-SC_OLD-50cd1ffd32f69228e566f2b0b89f86ea0d9fe489.zip
opensim-SC_OLD-50cd1ffd32f69228e566f2b0b89f86ea0d9fe489.tar.gz
opensim-SC_OLD-50cd1ffd32f69228e566f2b0b89f86ea0d9fe489.tar.bz2
opensim-SC_OLD-50cd1ffd32f69228e566f2b0b89f86ea0d9fe489.tar.xz
Merge branch 'SledjChisl'
Diffstat (limited to 'README.md')
-rw-r--r--README.md165
1 files changed, 9 insertions, 156 deletions
diff --git a/README.md b/README.md
index 31c1b05..c190f28 100644
--- a/README.md
+++ b/README.md
@@ -1,156 +1,9 @@
1NOTE - this is the OpenSim 0.8.2.1 version, the 0.9.0.1 version is in the 1opensim-SC is a fork of OpenSim, and OpenSim is a clean room fork of
2SledjChisl branch, which isn't quite ready yet. 2Second Life. They are all 3D virtual worlds that are open, users can
3 3create their own content, these are not games. Second Life is a
4 4proprietary server, with open source viewer. OpenSim is an open source
5Use this to create a sim that links into Infinite Grid from Linux. 5server that works with Second Life viewers.
6 6
7It's only been tested on Ubuntu 10.04, 11.04, 12.04, 16.04' as well as 7See doc/index.html for details. INSTALL.md for installation
8Debian 8, YMMV. This is also a WIP, use it at your own risk. It's been 8instructions. Differences.txt for the differences between OpenSim and
9used to set up a few freshly installed Ubuntu servers though. 9opensim-SC. coderDocs/ for the coder level documentation.
10
11The directory layout.
12---------------------
13
14The various directories are -
15
16.git Used by git for it's internal accounting, and the older versions.
17
18.nant Used by the nant build tool.
19
20OpenSim OpenSim source code.
21
22Prebuild Used by the build system.
23
24ThirdParty For third party OpenSim modules.
25
26addon-modules Also for third party modules. Don't ask me why there's two.
27
28bin The OpenSim binaries, and other files.
29
30doc Supposedly for documentation, which I wish OpenSim devs would write some.
31
32scripts Various Linux scripts for managing OpenSim.
33
34share No idea really.
35
36Also, the installation script moves the following directories to outside
37of this main directory, they are all used for writing various things.
38Makes it easy to upgrade, and separates them from actual executable
39stuff.
40
41AssetFiles Stores assets if running in grid mode.
42
43backups All sim and inventory backups are stored here.
44
45caches Various cached things.
46
47config All your configurtion files.
48
49db If you are not using MySQL, your data lives here.
50
51logs Log files get stored here.
52
53
54Follow these steps.
55-------------------
56
57Go to -
58
59https://www.infinitegrid.org/drupal/content/How_to_link_your_OpenSim_region_to_Infinite_Grid_LinuxMySQL
60
61and follow the directions to create an admin user account. You can skip
62that bit if you already have a suitable user with sudo access.
63
64Note that these scripts pretty much follow that above wiki description,
65with some exceptions. The configuration information per sim has been
66rearranged so that there is only ONE copy of the OpenSim installation.
67
68Next you need to figure out what password you want to use for OpenSims
69access to the database. We will call this "DatabasePassword". Run the
70following script, from inside the OpenSim directory -
71
72./InstallItAll.sh DatabasePassword
73
74This will do most of the work for you, except for creating sims. There
75is a final step that needs to be done manually for now. Edit
76/etc/rc.local, make sure it has the following line in it somewhere,
77probably at the end -
78
79/opt/opensim/current/scripts/fix_var_run.sh
80
81
82Creating sims.
83--------------
84
85A separate script is here for sim creation, you can use it to create many
86sims. You will need -
87
88Your host name, or it could be your IP, we will use "sims.example.net".
89
90A name for your sim, we will use "My new sim". It should be unique on
91the grid.
92
93A location for your sim, we will use "1234,5678". You can use the
94Infinite Grid web based map to poke around and find a good location.
95Choose an empty spot.
96
97Once you have all that information sorted out, run this script from the
98installed scripts directory -
99
100./create_sim.sh "My new sim" "1234,5678" "sims.example.net"
101
102Or this if you want to override the detected IP address -
103
104./create_sim.sh "My new sim" "1234,5678" "sims.example.net" "1.2.3.4"
105
106Also, you can create a varregion with something like -
107
108./create_sim.sh "My new sim" "1234,5678" "sims.example.net" "1.2.3.4" 512
109
110Note that the size has to be a multiple of 256, so 512, 768, 1024, etc.
111
112Running sims.
113-------------
114
115Now you can go to /opt/opensim/config/sim01 and run the following script
116to start it up -
117
118./start-sim
119
120You will see the screen console. You can run the screen console again by
121running that command once more, or running the sim-console command.
122
123You can stop the sim with -
124
125./stop-sim
126
127You can backup the sim with -
128
129./backup-sim
130
131
132
133Finishing up.
134-------------
135
136Once it's all tested, you can use this to finish things off (back in
137the scripts directory) -
138
139./go_live.sh
140
141Which sets up the monit control file/s, though you should double check
142it all, and you still have to do the basic configuration and enabling of
143monit yourself. This is in case you already have monit set the way you
144like.
145
146
147NOTES -
148
149This attempts to use only one copy of the OS install for all sims. We
150are running one instance of OS for each sim though, as this prevents one
151sim crashing from bringing down the others. OS however really wants to
152write data to directories within it's own bin directory. I'm not at all
153certian if that data can be shared. For the same reason, so far I've
154not been able to get to the point where we can make the OS directory
155read only. This complicates things during upgrades.
156