|
|
| (9 intermediate revisions by 4 users not shown) |
| Line 1: |
Line 1: |
| − | ==Basic Universal Server Technology (B.U.S.T.)==
| + | #REDIRECT [[ROBUST]] |
| − | ===Concepts===
| + | |
| − | B.U.S.T. leverages the system of in and out connectors and services that was developed for the Hypergrid and OpenSim. It replaces OGS1 with a modular architecture that can be easily extended using core and 3rd party modules.
| + | |
| − | | + | |
| − | B.U.S.T. is a flexible server shell that can load the same modules already used by regions. This allows for nearly 100% code reusability and great flexibility.
| + | |
| − | | + | |
| − | The B.U.S.T. server loads "in" connectors as specified in the configuration file. These connectors then load the required processing and storage modules and/or "out" connectors. Through this architecture, each B.U.S.T. server can run any or all grid services, and/or act as a proxy for grid services.
| + | |
| − | | + | |
| − | ===Configuration===
| + | |
| − | The server reads a configuration file at startup, which defaults to the name of the assembly with .ini appended. The default name for the B.U.S.T. server is OpenSim.Server.exe, therefore the default configuration file is OpenSim.Server.ini. An OpenSim.Server.ini.example file is provided with the OpenSim kit.
| + | |
| − | | + | |
| − | ; * The startup section lists all the connectors to start up in this server
| + | |
| − | ; * instance. This may be only one, or it may be the entire server suite.
| + | |
| − | ; * Multiple connectors should be seaprated by commas.
| + | |
| − | ; *
| + | |
| − | ; * These are the IN connectors the server uses, the in connectors
| + | |
| − | ; * read this config file and load the needed OUT and database connectors
| + | |
| − | ; *
| + | |
| − | [Startup]
| + | |
| − | ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector,OpenSim.Server.Handlers.dll:InventoryServiceInConnector"
| + | |
| − |
| + | |
| − | ; * This is common for all services, it's the network setup for the entire
| + | |
| − | ; * server instance
| + | |
| − | ; *
| + | |
| − | [Network]
| + | |
| − | port = 8003
| + | |
| − |
| + | |
| − | ; * As an example, the below configuration precisely mimicks the legacy
| + | |
| − | ; * asset server. It is read by the asset IN connector (defined above)
| + | |
| − | ; * and it then loads the OUT connector (a local database module). That,
| + | |
| − | ; * in turn, reads the asset loader and database connection information
| + | |
| − | ; *
| + | |
| − | [AssetService]
| + | |
| − | LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
| + | |
| − | DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
| + | |
| − | AssetLoaderArgs = "assets/AssetSets.xml"
| + | |
| − | StorageProvider = "OpenSim.Data.MySQL.dll"
| + | |
| − | ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"
| + | |
| − |
| + | |
| − | ; * This configuration loads the inventory server modules. It duplicates
| + | |
| − | ; * the function of the legacy inventory server
| + | |
| − | ; *
| + | |
| − | [InventoryService]
| + | |
| − | LocalServiceModule = "OpenSim.Services.InventoryService.dll:InventoryService"
| + | |
| − | UserServerURI = "http://127.0.0.1:8002"
| + | |
| − | SessionAuthentication = "false"
| + | |
| − | StorageProvider = "OpenSim.Data.MySQL.dll"
| + | |
| − | ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"
| + | |
| − | | + | |
| − | ===Command Line Arguments===
| + | |
| − | *-inifile
| + | |
| − | :Specify the location of the .ini file to read instead of the default
| + | |
| − | *-console
| + | |
| − | :Specify console type, one of basic, local or rest
| + | |
| − | *-logfile
| + | |
| − | :Specify the logfile this server will log to
| + | |
| − | *-prompt
| + | |
| − | :Override the server prompt
| + | |
| − | | + | |
| − | ==Configuration File==
| + | |
| − | ===Section [Startup]===
| + | |
| − | *ServiceConnectors
| + | |
| − | :Comma separated list of service IN connectors. The format of each entry is <dllname>:<classname>. If a dll contains only one suitable class, the class name can be omitted.
| + | |
| − | *Prompt
| + | |
| − | :Override the server prompt
| + | |
| − | *Console
| + | |
| − | :Specify console type, one of basic, local or rest
| + | |
| − | *Logfile
| + | |
| − | :Specify the logfile this server will log to
| + | |
| − | | + | |
| − | ===Section [Network]===
| + | |
| − | *Port
| + | |
| − | :Set the network port to listen on. All services will run on this port.
| + | |
| − | | + | |
| − | ==Connector Configurations==
| + | |
| − | These configurations are provided by the connector modules and are not an integral part of the B.U.S.T. server. Documentation to all possible options can be found in the documentation of the connector. This manual only lists the options present in the sample configuration file.
| + | |
| − | | + | |
| − | ===Section [AssetService]===
| + | |
| − | * LocalServiceModule [Connector option]
| + | |
| − | :A module specification (<dll>:<class>) that provides the services for this connector
| + | |
| − | * DefaultAssetLoader [Service option]
| + | |
| − | :A dll containing the asset loader to use for loading the default asset set
| + | |
| − | * AssetLoaderArgs [Service option]
| + | |
| − | :Path to load assets from (for the file system asset loader)
| + | |
| − | * StorageProvider [Service option]
| + | |
| − | :Dll containing the database provider code
| + | |
| − | * ConnectionString [Service option]
| + | |
| − | :Connection string to be passed to the database provider
| + | |
| − | | + | |
| − | ===Section [InventoryService]===
| + | |
| − | * LocalServiceModule [Connector option]
| + | |
| − | :A module specification (<dll>:<class>) that provides the services for this connector
| + | |
| − | * UserServerURI [Connector option]
| + | |
| − | :URI to reach the user server at
| + | |
| − | * SessionAuthentication [Connector option]
| + | |
| − | :Authenticate inventory sessions (default false!)
| + | |
| − | * StorageProvider [Service option]
| + | |
| − | :Dll containing the database provider code
| + | |
| − | * ConnectionString [Service option]
| + | |
| − | :Connection string to be passed to the database provider
| + | |
| − | | + | |
| − | Additional connectors may need additional sections to be added.
| + | |
| − | | + | |
| − | ==Alternate Configuration Files==
| + | |
| − | To run B.U.S.T. as separate processes, emulatig the legacy servers, you can copy the server executables to the names of the legacy servers:
| + | |
| − | cp OpenSim.Server.exe OpenSim.Grid.AssetServer.exe
| + | |
| − | cp OpenSim.Server.exe.config OpenSim.Grid.AssetServer.exe.config
| + | |
| − | cp OpenSim.Server.ini OpenSim.Grid.AssetServer.ini
| + | |
| − | | + | |
| − | Then, modify OpenSim.Grid.AssetServer.ini to read:
| + | |
| − | [Startup]
| + | |
| − | ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector"
| + | |
| − |
| + | |
| − | [Network]
| + | |
| − | port = 8003
| + | |
| − |
| + | |
| − | [AssetService]
| + | |
| − | LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"
| + | |
| − | DefaultAssetLoader = "OpenSim.Framework.AssetLoader.Filesystem.dll"
| + | |
| − | AssetLoaderArgs = "assets/AssetSets.xml"
| + | |
| − | StorageProvider = "OpenSim.Data.MySQL.dll"
| + | |
| − | ConnectionString = "Data Source=localhost;Database=grid;User ID=grid;Password=grid;"
| + | |
| − | | + | |
| − | Now, when you run OpenSim.Grid.AssetServer.exe, it will act like the legacy asset server it replaces.
| + | |
| − | | + | |
| − | You can do the same for all other supported services.
| + | |
