aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md188
1 files changed, 76 insertions, 112 deletions
diff --git a/README.md b/README.md
index 12cba74..2aea328 100644
--- a/README.md
+++ b/README.md
@@ -1,152 +1,116 @@
1Use this to create a sim that links into Infinite Grid from Linux. 1Welcome to OpenSim!
2 2
3It's only been tested on Ubuntu 10.04, 11.04, 12.04, 16.04' as well as 3# Overview
4Debian 8, YMMV. This is also a WIP, use it at your own risk. It's been
5used to set up a few freshly installed Ubuntu servers though.
6 4
7The directory layout. 5OpenSim is a BSD Licensed Open Source project to develop a functioning
8--------------------- 6virtual worlds server platform capable of supporting multiple clients
7and servers in a heterogeneous grid structure. OpenSim is written in
8C#, and can run under Mono or the Microsoft .NET runtimes.
9 9
10The various directories are - 10This is considered an alpha release. Some stuff works, a lot doesn't.
11If it breaks, you get to keep *both* pieces.
11 12
12.git Used by git for it's internal accounting, and the older versions. 13# Compiling OpenSim
13 14
14.nant Used by the nant build tool. 15Please see BUILDING.md if you downloaded a source distribution and
16need to build OpenSim before running it.
15 17
16OpenSim OpenSim source code. 18# Running OpenSim on Windows
17 19
18Prebuild Used by the build system. 20You will need .NET 4.0 installed to run OpenSimulator.
19 21
20ThirdParty For third party OpenSim modules. 22We recommend that you run OpenSim from a command prompt on Windows in order
23to capture any errors.
21 24
22addon-modules Also for third party modules. Don't ask me why there's two. 25To run OpenSim from a command prompt
23 26
24bin The OpenSim binaries, and other files. 27 * cd to the bin/ directory where you unpacked OpenSim
28 * run OpenSim.exe
25 29
26doc Supposedly for documentation, which I wish OpenSim devs would write some. 30Now see the "Configuring OpenSim" section
27 31
28scripts Various Linux scripts for managing OpenSim. 32# Running OpenSim on Linux
29 33
30share No idea really. 34You will need Mono >= 2.10.8.1 to run OpenSimulator. On some Linux distributions you
35may need to install additional packages. See http://opensimulator.org/wiki/Dependencies
36for more information.
31 37
32Also, the installation script moves the following directories to outside 38To run OpenSim, from the unpacked distribution type:
33of this main directory, they are all used for writing various things.
34Makes it easy to upgrade, and separates them from actual executable
35stuff.
36 39
37AssetFiles Stores assets if running in grid mode. 40 * cd bin
41 * mono OpenSim.exe
38 42
39backups All sim and inventory backups are stored here. 43Now see the "Configuring OpenSim" section
40 44
41caches Various cached things. 45# Configuring OpenSim
42 46
43config All your configurtion files. 47When OpenSim starts for the first time, you will be prompted with a
48series of questions that look something like:
44 49
45db If you are not using MySQL, your data lives here. 50 [09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]:
46 51
47logs Log files get stored here. 52For all the options except simulator name, you can safely hit enter to accept
53the default if you want to connect using a client on the same machine or over
54your local network.
48 55
56You will then be asked "Do you wish to join an existing estate?". If you're
57starting OpenSim for the first time then answer no (which is the default) and
58provide an estate name.
49 59
50Follow these steps. 60Shortly afterwards, you will then be asked to enter an estate owner first name,
51------------------- 61last name, password and e-mail (which can be left blank). Do not forget these
62details, since initially only this account will be able to manage your region
63in-world. You can also use these details to perform your first login.
52 64
53Go to - 65Once you are presented with a prompt that looks like:
54 66
55https://www.infinitegrid.org/drupal/content/How_to_link_your_OpenSim_region_to_Infinite_Grid_LinuxMySQL 67 Region (My region name) #
56 68
57and follow the directions to create an admin user account. You can skip 69You have successfully started OpenSim.
58that bit if you already have a suitable user with sudo access.
59 70
60Note that these scripts pretty much follow that above wiki description, 71If you want to create another user account to login rather than the estate
61with some exceptions. The configuration information per sim has been 72account, then type "create user" on the OpenSim console and follow the prompts.
62rearranged so that there is only ONE copy of the OpenSim installation.
63 73
64Next you need to figure out what password you want to use for OpenSims 74Helpful resources:
65access to the database. We will call this "DatabasePassword". Run the 75 * http://opensimulator.org/wiki/Configuration
66following script, from inside the OpenSim directory - 76 * http://opensimulator.org/wiki/Configuring_Regions
67 77
68./InstallItAll.sh DatabasePassword 78# Connecting to your OpenSim
69 79
70This will do most of the work for you, except for creating sims. There 80By default your sim will be available for login on port 9000. You can login by
71is a final step that needs to be done manually for now. Edit 81adding -loginuri http://127.0.0.1:9000 to the command that starts Second Life
72/etc/rc.local, make sure it has the following line in it somewhere, 82(e.g. in the Target: box of the client icon properties on Windows). You can
73probably at the end - 83also login using the network IP address of the machine running OpenSim (e.g.
84http://192.168.1.2:9000)
74 85
75/opt/opensim/current/scripts/fix_var_run.sh 86To login, use the avatar details that you gave for your estate ownership or the
87one you set up using the "create user" command.
76 88
89# Bug reports
77 90
78Creating sims. 91In the very likely event of bugs biting you (err, your OpenSim) we
79-------------- 92encourage you to see whether the problem has already been reported on
93the [OpenSim mantis system](http://opensimulator.org/mantis/main_page.php).
80 94
81A separate script is here for sim creation, you can use it to create many 95If your bug has already been reported, you might want to add to the
82sims. You will need - 96bug description and supply additional information.
83 97
84Your host name, or it could be your IP, we will use "sims.example.net". 98If your bug has not been reported yet, file a bug report ("opening a
99mantis"). Useful information to include:
100 * description of what went wrong
101 * stack trace
102 * OpenSim.log (attach as file)
103 * OpenSim.ini (attach as file)
104 * if running under mono: run OpenSim.exe with the "--debug" flag:
85 105
86A name for your sim, we will use "My new sim". It should be unique on 106 mono --debug OpenSim.exe
87the grid.
88 107
89A location for your sim, we will use "1234,5678". You can use the 108# More Information on OpenSim
90Infinite Grid web based map to poke around and find a good location.
91Choose an empty spot.
92 109
93Once you have all that information sorted out, run this script from the 110More extensive information on building, running, and configuring
94installed scripts directory - 111OpenSim, as well as how to report bugs, and participate in the OpenSim
112project can always be found at http://opensimulator.org.
95 113
96./create_sim.sh "My new sim" "1234,5678" "sims.example.net" 114Thanks for trying OpenSim, we hope it is a pleasant experience.
97 115
98Or this if you want to override the detected IP address -
99
100./create_sim.sh "My new sim" "1234,5678" "sims.example.net" "1.2.3.4"
101
102Also, you can create a varregion with something like -
103
104./create_sim.sh "My new sim" "1234,5678" "sims.example.net" "1.2.3.4" 512
105
106Note that the size has to be a multiple of 256, so 512, 768, 1024, etc.
107
108Running sims.
109-------------
110
111Now you can go to /opt/opensim/config/sim01 and run the following script
112to start it up -
113
114./start-sim
115
116You will see the screen console. You can run the screen console again by
117running that command once more, or running the sim-console command.
118
119You can stop the sim with -
120
121./stop-sim
122
123You can backup the sim with -
124
125./backup-sim
126
127
128
129Finishing up.
130-------------
131
132Once it's all tested, you can use this to finish things off (back in
133the scripts directory) -
134
135./go_live.sh
136
137Which sets up the monit control file/s, though you should double check
138it all, and you still have to do the basic configuration and enabling of
139monit yourself. This is in case you already have monit set the way you
140like.
141
142
143NOTES -
144
145This attempts to use only one copy of the OS install for all sims. We
146are running one instance of OS for each sim though, as this prevents one
147sim crashing from bringing down the others. OS however really wants to
148write data to directories within it's own bin directory. I'm not at all
149certian if that data can be shared. For the same reason, so far I've
150not been able to get to the point where we can make the OS directory
151read only. This complicates things during upgrades.
152 116