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