OpenSimulator - User contributions [en]

RestConsole

2018-04-10T14:06:56Z

Thomax: /* NOTE */

{{Quicklinks|RestConsole}}{{ReleaseInfo}}
== About ==
The REST console makes remote administration of the various OpenSimulator services possible.

The interface allows sending commands to the server and retrieving command output. Sending and receiving data is done through RESTful HTTP calls.

While sending is very straightforward, receiving is not. Receiving uses reverse HTTP, performing a long poll to a CAPS URI.

In order to make the protocol more efficient, the help functionality has been pushed to the client side. Rather than sending each keystroke to the server, only validated command lines are sent. To make this possible, the server sends a burst-on-connect of data, which is the tree of allowed commands and their help information. This can be used by the client to create the "help" command output locally as well as provide command line help interactively.

The sample console client, OpenSim.ConsoleClient.exe, shows how this is done.

== Usage ==
In order to use the remote console, start up OpenSimulator services with parameter <tt>-console rest</tt>.

Example for Robust server in grid mode:
mono Robust.exe -console rest

Example for simulators (both in grid and standalone mode):
mono OpenSim.exe -console rest

== Syntax ==
We take the OpenSimulator services address <nowiki>http://foo.bar:8002</nowiki> as example here.

First start a new session by sending a HTTP POST request. User name and password should match the settings for <tt>ConsoleUser</tt> and <tt>ConsolePass</tt> in section <tt>[Network]</tt> of OpenSim.ini.<br />
Parameters: USER, PASS
<nowiki>http://foo.bar:8002/StartSession/</nowiki>
Return: (XML) <ConsoleSession><SessionID></SessionID><Prompt></Prompt></ConsoleSession>

Now we got the SessionID, which can be used to send a command and to receive output. First, retrieve the console scrollback buffer.<br />
Parameters: none
<nowiki>http://foo.bar:8002/ReadResponses/<SessionID>/</nowiki>
Return: (XML) <ConsoleSession><Line Number=x Level=l Prompt=p Command=c Input=i></Line></ConsoleSession><br />
The reply contains all lines currently in the buffer. Subsequent fetches will only retrieve new lines. The fetch will hold for up to 30 seconds if there is no data, then return an error. The client is expected to try again (polling).
The attributes are as follows:
Number = The line number (1 based)
Level = The level this is to be logged as
Prompt = bool, true if the output on this line is a prompt
Command = bool, true if the prompt is for a command
Input = bool, true if the output is eachoed input

Use the SessionID as ID parameter, and send a POST request again.<br />
Parameters: ID, COMMAND
<nowiki>http://foo.bar:8002/SessionCommand/</nowiki>
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession><br />
If everything went well, the command should have been executed. Try another command.

When you want to close down the connection, send a POST request again.<br />
Parameters: ID
<nowiki>http://foo.bar:8002/CloseSession/</nowiki>
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession><br />
The session is closed, and you have to log in again, when you want to send a command again.

= Clients =

== C# ==

A C# client is included with the Opensimulator distribution. It is rudimentary and not updated to the latest protocol versions.

== Qt ==

The Qt 5 based client is at https://github.com/MelanieT/OpenSimConsoleClient

= Binaries =
Windows: http://opensimulator.org/downloads/ConsoleClient.zip
Mac: http://opensimulator.org/downloads/ConsoleClient.dmg
Linux: TBD

= Examples =

== NOTE ==

Some of the examples below are for an older version of the interface. They may work to a degree but need to be revised.

=== node.js ===

<source lang="javascript">
/*
| This piece of code is published by thomax (tx0h) (c) 2018 under the
| Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)
|
| I removed my previous python approach because blueman made a better
| version and it was outdated. Here is a node.js variant.
*/

const readline = require('readline');
var Client = require('node-rest-client').Client;
var client = new Client();
var session_id;
var base_url = "http://127.0.0.1:9000";

// set http header
var headers = {
"Content-Type": "application/x-www-form-urlencoded",
"User-Agent": "nodejs-console/0.01"
};

// open session
function open_session() {
var args = {
data: {
"USER": "Test",
"PASS": 'secret'
},
headers,
};

client.post(base_url + "/StartSession/", args, function (data, response) {
session_id = data.ConsoleSession.SessionID;
read_session_buffer();
});
}

// close session
function close_session() {
args = {
data: { "ID": session_id },
headers
};

client.post(base_url + "/CloseSession/", args, function (data, response) {
console.log("close_session: "+response);
});

console.log('Have a great day!');
process.exit(0);
}

// read all the lines from the console buffer and print them
function read_session_buffer() {
args = {
data: { "ID": session_id },
headers
};

client.post(base_url + "/ReadResponses/"+session_id+"/", args, function (data, response) {
if(data.ConsoleSession.Line) {
var i;
for(i=0; i < data.ConsoleSession.Line.length; i++) {
if(data.ConsoleSession.Line[i]._) {
console.log(data.ConsoleSession.Line[i]._);
}
}
rl.prompt();
}
});
}

// execute the command from the prompt
function execute_cmd(cmd) {
args = {
data: {
"ID": session_id,
"COMMAND": cmd
},
headers
};

client.post(base_url + "/SessionCommand/", args, function (data, response) {
});
}

// here we go.
open_session();

// prepare readline
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout,
prompt: 'REST CONSOLE> '
});
rl.prompt();

// hunt for events
rl.on('line', (line) => {
switch (line.trim()) {
case 'quit':
close_session();
break;
default:
if(line.length > 0) {
execute_cmd(line.trim());
}
break;
}
read_session_buffer();
rl.prompt();
}).on('close', () => {
close_session();
});
</source>

=== Python (Updated) ===

<source lang="python">
#!/usr/bin/python
# This piece of code is published by thomax (txOh) (c) 2010 under the
# Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)
# Modifications (c) 2013 BlueWall

import urllib, urllib2
import xml.dom.minidom

class UserConsoleClient():

def __init__(self, addr):
self.addr = addr
url = self.addr + 'StartSession/'

params = urllib.urlencode({
'USER': 'username', # REST username
'PASS': 'userpass' # REST password
})
data = urllib2.urlopen(url, params).read()
print data

dom = xml.dom.minidom.parseString(data)
elem = dom.getElementsByTagName('SessionID')
self.sessionid = elem[0].childNodes[0].nodeValue
elem = dom.getElementsByTagName('Prompt')
self.prompt = elem[0].childNodes[0].nodeValue + '# '

def close(self):
url = self.addr + 'CloseSession/'
params = urllib.urlencode({
'ID': self.sessionid
})
print urllib2.urlopen(url, params).read()

def do_cmd(self, cmd):
url = self.addr + 'SessionCommand/'
params = urllib.urlencode({
'ID': self.sessionid,
'COMMAND': cmd
})
data = urllib2.urlopen(url, params).read()
dom = xml.dom.minidom.parseString(data)
elem = dom.getElementsByTagName('Result')
return elem[0].childNodes[0].nodeValue

def read_buffer(self):
url = self.addr + 'ReadResponses/' + self.sessionid + '/'
params = urllib.urlencode({
'ID': self.sessionid
})

# print urllib2.urlopen(url, params).read()

result = urllib2.urlopen(url, params).read()
dom = xml.dom.minidom.parseString(result)

elem = dom.getElementsByTagName('Line')
for line in elem:
x0 = line.childNodes[0].nodeValue
x1 = str.replace(str(x0),':','~',2)
x2 = x1.split("~")
for lv in x2[2:]:
if not '+++' in lv:
print lv

# set the base url to the REST console (with port)
console = UserConsoleClient('http://example.com:8003/')
console.read_buffer()
print 'quit with a "."'
cmd = ""
while cmd != ".":
if cmd != "":
if 'OK' in console.do_cmd(cmd):
console.read_buffer()
cmd = raw_input("%s " % console.prompt)

console.close()

</source>

=== JavaScript/HTML ===

<pre>
<html>
<head>




<script type="text/javascript">

var sessionId;
var hostUrl;

function StartSession(url, user, password) {
hostUrl = url;
var response = SendRequest("/StartSession/", "USER=" + user + "&PASS=" + password);
sessionId = response.getElementsByTagName("SessionID")[0].firstChild.nodeValue;
};

function ReadResponses() {
var response = this.SendRequest("/ReadResponses/" + sessionId + "/", '');
var lines = response.getElementsByTagName("Line");
for (var i = 0; i < lines.length; ++i) {
var element = document.createElement("div");
element.appendChild(document.createTextNode(lines[i].firstChild.nodeValue));
document.getElementById("output").appendChild(element);
};
document.getElementById("output").scrollTop = document.getElementById("output").scrollHeight;
};

function Command(cmd) {
void SendRequest("/SessionCommand/", "ID=" + sessionId + "&COMMAND=" + cmd);
};

function CloseSession() {
void SendRequest("/CloseSession/", "ID=" + sessionId);
};

function SendRequest(path, data) {
var request = new XMLHttpRequest();
request.open("POST", hostUrl + path, false);
request.send(data);
return request.responseXML;
};

window.onunload = CloseSession;

</script>
</head>
<body>

<form action="#" onsubmit="
StartSession(this.address.value, this.user.value, this.password.value);
ReadResponses();
return false">
<input name="address" type="text" value="http://localhost:9000" />
<input name="user" type="text" value="ConsoleUser" />
<input name="password" type="text" value="ConsolePass" />
<input type="submit" value="Login" />
</form>

<div id="output" style="height:15em; border:thin solid; overflow:auto;"></div>

<form action="#" onsubmit="
Command(this.command.value);
ReadResponses();
return false">
<input type="text" name="command" value="Enter command here" size="40"/>
<input type="submit" value="Send Command" />
</form>

</body>
</html>
</pre>

RestConsole

2018-04-10T14:06:02Z

Thomax: /* node.js */

{{Quicklinks|RestConsole}}{{ReleaseInfo}}
== About ==
The REST console makes remote administration of the various OpenSimulator services possible.

The interface allows sending commands to the server and retrieving command output. Sending and receiving data is done through RESTful HTTP calls.

While sending is very straightforward, receiving is not. Receiving uses reverse HTTP, performing a long poll to a CAPS URI.

In order to make the protocol more efficient, the help functionality has been pushed to the client side. Rather than sending each keystroke to the server, only validated command lines are sent. To make this possible, the server sends a burst-on-connect of data, which is the tree of allowed commands and their help information. This can be used by the client to create the "help" command output locally as well as provide command line help interactively.

The sample console client, OpenSim.ConsoleClient.exe, shows how this is done.

== Usage ==
In order to use the remote console, start up OpenSimulator services with parameter <tt>-console rest</tt>.

Example for Robust server in grid mode:
mono Robust.exe -console rest

Example for simulators (both in grid and standalone mode):
mono OpenSim.exe -console rest

== Syntax ==
We take the OpenSimulator services address <nowiki>http://foo.bar:8002</nowiki> as example here.

First start a new session by sending a HTTP POST request. User name and password should match the settings for <tt>ConsoleUser</tt> and <tt>ConsolePass</tt> in section <tt>[Network]</tt> of OpenSim.ini.<br />
Parameters: USER, PASS
<nowiki>http://foo.bar:8002/StartSession/</nowiki>
Return: (XML) <ConsoleSession><SessionID></SessionID><Prompt></Prompt></ConsoleSession>

Now we got the SessionID, which can be used to send a command and to receive output. First, retrieve the console scrollback buffer.<br />
Parameters: none
<nowiki>http://foo.bar:8002/ReadResponses/<SessionID>/</nowiki>
Return: (XML) <ConsoleSession><Line Number=x Level=l Prompt=p Command=c Input=i></Line></ConsoleSession><br />
The reply contains all lines currently in the buffer. Subsequent fetches will only retrieve new lines. The fetch will hold for up to 30 seconds if there is no data, then return an error. The client is expected to try again (polling).
The attributes are as follows:
Number = The line number (1 based)
Level = The level this is to be logged as
Prompt = bool, true if the output on this line is a prompt
Command = bool, true if the prompt is for a command
Input = bool, true if the output is eachoed input

Use the SessionID as ID parameter, and send a POST request again.<br />
Parameters: ID, COMMAND
<nowiki>http://foo.bar:8002/SessionCommand/</nowiki>
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession><br />
If everything went well, the command should have been executed. Try another command.

When you want to close down the connection, send a POST request again.<br />
Parameters: ID
<nowiki>http://foo.bar:8002/CloseSession/</nowiki>
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession><br />
The session is closed, and you have to log in again, when you want to send a command again.

= Clients =

== C# ==

A C# client is included with the Opensimulator distribution. It is rudimentary and not updated to the latest protocol versions.

== Qt ==

The Qt 5 based client is at https://github.com/MelanieT/OpenSimConsoleClient

= Binaries =
Windows: http://opensimulator.org/downloads/ConsoleClient.zip
Mac: http://opensimulator.org/downloads/ConsoleClient.dmg
Linux: TBD

= Examples =

== NOTE ==

The below examples are for an older version of the interface. They may work to a degree but need to be revised.

=== node.js ===

<source lang="javascript">
/*
| This piece of code is published by thomax (tx0h) (c) 2018 under the
| Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)
|
| I removed my previous python approach because blueman made a better
| version and it was outdated. Here is a node.js variant.
*/

const readline = require('readline');
var Client = require('node-rest-client').Client;
var client = new Client();
var session_id;
var base_url = "http://127.0.0.1:9000";

// set http header
var headers = {
"Content-Type": "application/x-www-form-urlencoded",
"User-Agent": "nodejs-console/0.01"
};

// open session
function open_session() {
var args = {
data: {
"USER": "Test",
"PASS": 'secret'
},
headers,
};

client.post(base_url + "/StartSession/", args, function (data, response) {
session_id = data.ConsoleSession.SessionID;
read_session_buffer();
});
}

// close session
function close_session() {
args = {
data: { "ID": session_id },
headers
};

client.post(base_url + "/CloseSession/", args, function (data, response) {
console.log("close_session: "+response);
});

console.log('Have a great day!');
process.exit(0);
}

// read all the lines from the console buffer and print them
function read_session_buffer() {
args = {
data: { "ID": session_id },
headers
};

client.post(base_url + "/ReadResponses/"+session_id+"/", args, function (data, response) {
if(data.ConsoleSession.Line) {
var i;
for(i=0; i < data.ConsoleSession.Line.length; i++) {
if(data.ConsoleSession.Line[i]._) {
console.log(data.ConsoleSession.Line[i]._);
}
}
rl.prompt();
}
});
}

// execute the command from the prompt
function execute_cmd(cmd) {
args = {
data: {
"ID": session_id,
"COMMAND": cmd
},
headers
};

client.post(base_url + "/SessionCommand/", args, function (data, response) {
});
}

// here we go.
open_session();

// prepare readline
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout,
prompt: 'REST CONSOLE> '
});
rl.prompt();

// hunt for events
rl.on('line', (line) => {
switch (line.trim()) {
case 'quit':
close_session();
break;
default:
if(line.length > 0) {
execute_cmd(line.trim());
}
break;
}
read_session_buffer();
rl.prompt();
}).on('close', () => {
close_session();
});
</source>

=== Python (Updated) ===

<source lang="python">
#!/usr/bin/python
# This piece of code is published by thomax (txOh) (c) 2010 under the
# Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)
# Modifications (c) 2013 BlueWall

import urllib, urllib2
import xml.dom.minidom

class UserConsoleClient():

def __init__(self, addr):
self.addr = addr
url = self.addr + 'StartSession/'

params = urllib.urlencode({
'USER': 'username', # REST username
'PASS': 'userpass' # REST password
})
data = urllib2.urlopen(url, params).read()
print data

dom = xml.dom.minidom.parseString(data)
elem = dom.getElementsByTagName('SessionID')
self.sessionid = elem[0].childNodes[0].nodeValue
elem = dom.getElementsByTagName('Prompt')
self.prompt = elem[0].childNodes[0].nodeValue + '# '

def close(self):
url = self.addr + 'CloseSession/'
params = urllib.urlencode({
'ID': self.sessionid
})
print urllib2.urlopen(url, params).read()

def do_cmd(self, cmd):
url = self.addr + 'SessionCommand/'
params = urllib.urlencode({
'ID': self.sessionid,
'COMMAND': cmd
})
data = urllib2.urlopen(url, params).read()
dom = xml.dom.minidom.parseString(data)
elem = dom.getElementsByTagName('Result')
return elem[0].childNodes[0].nodeValue

def read_buffer(self):
url = self.addr + 'ReadResponses/' + self.sessionid + '/'
params = urllib.urlencode({
'ID': self.sessionid
})

# print urllib2.urlopen(url, params).read()

result = urllib2.urlopen(url, params).read()
dom = xml.dom.minidom.parseString(result)

elem = dom.getElementsByTagName('Line')
for line in elem:
x0 = line.childNodes[0].nodeValue
x1 = str.replace(str(x0),':','~',2)
x2 = x1.split("~")
for lv in x2[2:]:
if not '+++' in lv:
print lv

# set the base url to the REST console (with port)
console = UserConsoleClient('http://example.com:8003/')
console.read_buffer()
print 'quit with a "."'
cmd = ""
while cmd != ".":
if cmd != "":
if 'OK' in console.do_cmd(cmd):
console.read_buffer()
cmd = raw_input("%s " % console.prompt)

console.close()

</source>

=== JavaScript/HTML ===

<pre>
<html>
<head>




<script type="text/javascript">

var sessionId;
var hostUrl;

function StartSession(url, user, password) {
hostUrl = url;
var response = SendRequest("/StartSession/", "USER=" + user + "&PASS=" + password);
sessionId = response.getElementsByTagName("SessionID")[0].firstChild.nodeValue;
};

function ReadResponses() {
var response = this.SendRequest("/ReadResponses/" + sessionId + "/", '');
var lines = response.getElementsByTagName("Line");
for (var i = 0; i < lines.length; ++i) {
var element = document.createElement("div");
element.appendChild(document.createTextNode(lines[i].firstChild.nodeValue));
document.getElementById("output").appendChild(element);
};
document.getElementById("output").scrollTop = document.getElementById("output").scrollHeight;
};

function Command(cmd) {
void SendRequest("/SessionCommand/", "ID=" + sessionId + "&COMMAND=" + cmd);
};

function CloseSession() {
void SendRequest("/CloseSession/", "ID=" + sessionId);
};

function SendRequest(path, data) {
var request = new XMLHttpRequest();
request.open("POST", hostUrl + path, false);
request.send(data);
return request.responseXML;
};

window.onunload = CloseSession;

</script>
</head>
<body>

<form action="#" onsubmit="
StartSession(this.address.value, this.user.value, this.password.value);
ReadResponses();
return false">
<input name="address" type="text" value="http://localhost:9000" />
<input name="user" type="text" value="ConsoleUser" />
<input name="password" type="text" value="ConsolePass" />
<input type="submit" value="Login" />
</form>

<div id="output" style="height:15em; border:thin solid; overflow:auto;"></div>

<form action="#" onsubmit="
Command(this.command.value);
ReadResponses();
return false">
<input type="text" name="command" value="Enter command here" size="40"/>
<input type="submit" value="Send Command" />
</form>

</body>
</html>
</pre>

RestConsole

2018-04-10T14:03:10Z

Thomax: /* node.js */

{{Quicklinks|RestConsole}}{{ReleaseInfo}}
== About ==
The REST console makes remote administration of the various OpenSimulator services possible.

The interface allows sending commands to the server and retrieving command output. Sending and receiving data is done through RESTful HTTP calls.

While sending is very straightforward, receiving is not. Receiving uses reverse HTTP, performing a long poll to a CAPS URI.

In order to make the protocol more efficient, the help functionality has been pushed to the client side. Rather than sending each keystroke to the server, only validated command lines are sent. To make this possible, the server sends a burst-on-connect of data, which is the tree of allowed commands and their help information. This can be used by the client to create the "help" command output locally as well as provide command line help interactively.

The sample console client, OpenSim.ConsoleClient.exe, shows how this is done.

== Usage ==
In order to use the remote console, start up OpenSimulator services with parameter <tt>-console rest</tt>.

Example for Robust server in grid mode:
mono Robust.exe -console rest

Example for simulators (both in grid and standalone mode):
mono OpenSim.exe -console rest

== Syntax ==
We take the OpenSimulator services address <nowiki>http://foo.bar:8002</nowiki> as example here.

First start a new session by sending a HTTP POST request. User name and password should match the settings for <tt>ConsoleUser</tt> and <tt>ConsolePass</tt> in section <tt>[Network]</tt> of OpenSim.ini.<br />
Parameters: USER, PASS
<nowiki>http://foo.bar:8002/StartSession/</nowiki>
Return: (XML) <ConsoleSession><SessionID></SessionID><Prompt></Prompt></ConsoleSession>

Now we got the SessionID, which can be used to send a command and to receive output. First, retrieve the console scrollback buffer.<br />
Parameters: none
<nowiki>http://foo.bar:8002/ReadResponses/<SessionID>/</nowiki>
Return: (XML) <ConsoleSession><Line Number=x Level=l Prompt=p Command=c Input=i></Line></ConsoleSession><br />
The reply contains all lines currently in the buffer. Subsequent fetches will only retrieve new lines. The fetch will hold for up to 30 seconds if there is no data, then return an error. The client is expected to try again (polling).
The attributes are as follows:
Number = The line number (1 based)
Level = The level this is to be logged as
Prompt = bool, true if the output on this line is a prompt
Command = bool, true if the prompt is for a command
Input = bool, true if the output is eachoed input

Use the SessionID as ID parameter, and send a POST request again.<br />
Parameters: ID, COMMAND
<nowiki>http://foo.bar:8002/SessionCommand/</nowiki>
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession><br />
If everything went well, the command should have been executed. Try another command.

When you want to close down the connection, send a POST request again.<br />
Parameters: ID
<nowiki>http://foo.bar:8002/CloseSession/</nowiki>
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession><br />
The session is closed, and you have to log in again, when you want to send a command again.

= Clients =

== C# ==

A C# client is included with the Opensimulator distribution. It is rudimentary and not updated to the latest protocol versions.

== Qt ==

The Qt 5 based client is at https://github.com/MelanieT/OpenSimConsoleClient

= Binaries =
Windows: http://opensimulator.org/downloads/ConsoleClient.zip
Mac: http://opensimulator.org/downloads/ConsoleClient.dmg
Linux: TBD

= Examples =

== NOTE ==

The below examples are for an older version of the interface. They may work to a degree but need to be revised.

=== node.js ===

<source lang="javascript">
/*
| This piece of code is published by thomax (txOh) (c) 2018 under the
| Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)
|
| I removed my previous python approach because blueman made a better
| version and it was outdated. Here is a node.js variant.
*/

const readline = require('readline');
var Client = require('node-rest-client').Client;
var client = new Client();
var session_id;
var base_url = "http://127.0.0.1:9000";

// set http header
var headers = {
"Content-Type": "application/x-www-form-urlencoded",
"User-Agent": "nodejs-console/0.01"
};

// open session
function open_session() {
var args = {
data: {
"USER": "Test",
"PASS": 'secret'
},
headers,
};

client.post(base_url + "/StartSession/", args, function (data, response) {
session_id = data.ConsoleSession.SessionID;
read_session_buffer();
});
}

// close session
function close_session() {
args = {
data: { "ID": session_id },
headers
};

client.post(base_url + "/CloseSession/", args, function (data, response) {
console.log("close_session: "+response);
});

console.log('Have a great day!');
process.exit(0);
}

// read all the lines from the console buffer and print them
function read_session_buffer() {
args = {
data: { "ID": session_id },
headers
};

client.post(base_url + "/ReadResponses/"+session_id+"/", args, function (data, response) {
if(data.ConsoleSession.Line) {
var i;
for(i=0; i < data.ConsoleSession.Line.length; i++) {
if(data.ConsoleSession.Line[i]._) {
console.log(data.ConsoleSession.Line[i]._);
}
}
rl.prompt();
}
});
}

// execute the command from the prompt
function execute_cmd(cmd) {
args = {
data: {
"ID": session_id,
"COMMAND": cmd
},
headers
};

client.post(base_url + "/SessionCommand/", args, function (data, response) {
});
}

// here we go.
open_session();

// prepare readline
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout,
prompt: 'REST CONSOLE> '
});
rl.prompt();

// hunt for events
rl.on('line', (line) => {
switch (line.trim()) {
case 'quit':
close_session();
break;
default:
if(line.length > 0) {
execute_cmd(line.trim());
}
break;
}
read_session_buffer();
rl.prompt();
}).on('close', () => {
close_session();
});
</source>

=== Python (Updated) ===

<source lang="python">
#!/usr/bin/python
# This piece of code is published by thomax (txOh) (c) 2010 under the
# Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)
# Modifications (c) 2013 BlueWall

import urllib, urllib2
import xml.dom.minidom

class UserConsoleClient():

def __init__(self, addr):
self.addr = addr
url = self.addr + 'StartSession/'

params = urllib.urlencode({
'USER': 'username', # REST username
'PASS': 'userpass' # REST password
})
data = urllib2.urlopen(url, params).read()
print data

dom = xml.dom.minidom.parseString(data)
elem = dom.getElementsByTagName('SessionID')
self.sessionid = elem[0].childNodes[0].nodeValue
elem = dom.getElementsByTagName('Prompt')
self.prompt = elem[0].childNodes[0].nodeValue + '# '

def close(self):
url = self.addr + 'CloseSession/'
params = urllib.urlencode({
'ID': self.sessionid
})
print urllib2.urlopen(url, params).read()

def do_cmd(self, cmd):
url = self.addr + 'SessionCommand/'
params = urllib.urlencode({
'ID': self.sessionid,
'COMMAND': cmd
})
data = urllib2.urlopen(url, params).read()
dom = xml.dom.minidom.parseString(data)
elem = dom.getElementsByTagName('Result')
return elem[0].childNodes[0].nodeValue

def read_buffer(self):
url = self.addr + 'ReadResponses/' + self.sessionid + '/'
params = urllib.urlencode({
'ID': self.sessionid
})

# print urllib2.urlopen(url, params).read()

result = urllib2.urlopen(url, params).read()
dom = xml.dom.minidom.parseString(result)

elem = dom.getElementsByTagName('Line')
for line in elem:
x0 = line.childNodes[0].nodeValue
x1 = str.replace(str(x0),':','~',2)
x2 = x1.split("~")
for lv in x2[2:]:
if not '+++' in lv:
print lv

# set the base url to the REST console (with port)
console = UserConsoleClient('http://example.com:8003/')
console.read_buffer()
print 'quit with a "."'
cmd = ""
while cmd != ".":
if cmd != "":
if 'OK' in console.do_cmd(cmd):
console.read_buffer()
cmd = raw_input("%s " % console.prompt)

console.close()

</source>

=== JavaScript/HTML ===

<pre>
<html>
<head>




<script type="text/javascript">

var sessionId;
var hostUrl;

function StartSession(url, user, password) {
hostUrl = url;
var response = SendRequest("/StartSession/", "USER=" + user + "&PASS=" + password);
sessionId = response.getElementsByTagName("SessionID")[0].firstChild.nodeValue;
};

function ReadResponses() {
var response = this.SendRequest("/ReadResponses/" + sessionId + "/", '');
var lines = response.getElementsByTagName("Line");
for (var i = 0; i < lines.length; ++i) {
var element = document.createElement("div");
element.appendChild(document.createTextNode(lines[i].firstChild.nodeValue));
document.getElementById("output").appendChild(element);
};
document.getElementById("output").scrollTop = document.getElementById("output").scrollHeight;
};

function Command(cmd) {
void SendRequest("/SessionCommand/", "ID=" + sessionId + "&COMMAND=" + cmd);
};

function CloseSession() {
void SendRequest("/CloseSession/", "ID=" + sessionId);
};

function SendRequest(path, data) {
var request = new XMLHttpRequest();
request.open("POST", hostUrl + path, false);
request.send(data);
return request.responseXML;
};

window.onunload = CloseSession;

</script>
</head>
<body>

<form action="#" onsubmit="
StartSession(this.address.value, this.user.value, this.password.value);
ReadResponses();
return false">
<input name="address" type="text" value="http://localhost:9000" />
<input name="user" type="text" value="ConsoleUser" />
<input name="password" type="text" value="ConsolePass" />
<input type="submit" value="Login" />
</form>

<div id="output" style="height:15em; border:thin solid; overflow:auto;"></div>

<form action="#" onsubmit="
Command(this.command.value);
ReadResponses();
return false">
<input type="text" name="command" value="Enter command here" size="40"/>
<input type="submit" value="Send Command" />
</form>

</body>
</html>
</pre>

RestConsole

2018-04-10T14:02:16Z

Thomax: /* javascript */

{{Quicklinks|RestConsole}}{{ReleaseInfo}}
== About ==
The REST console makes remote administration of the various OpenSimulator services possible.

The interface allows sending commands to the server and retrieving command output. Sending and receiving data is done through RESTful HTTP calls.

While sending is very straightforward, receiving is not. Receiving uses reverse HTTP, performing a long poll to a CAPS URI.

In order to make the protocol more efficient, the help functionality has been pushed to the client side. Rather than sending each keystroke to the server, only validated command lines are sent. To make this possible, the server sends a burst-on-connect of data, which is the tree of allowed commands and their help information. This can be used by the client to create the "help" command output locally as well as provide command line help interactively.

The sample console client, OpenSim.ConsoleClient.exe, shows how this is done.

== Usage ==
In order to use the remote console, start up OpenSimulator services with parameter <tt>-console rest</tt>.

Example for Robust server in grid mode:
mono Robust.exe -console rest

Example for simulators (both in grid and standalone mode):
mono OpenSim.exe -console rest

== Syntax ==
We take the OpenSimulator services address <nowiki>http://foo.bar:8002</nowiki> as example here.

First start a new session by sending a HTTP POST request. User name and password should match the settings for <tt>ConsoleUser</tt> and <tt>ConsolePass</tt> in section <tt>[Network]</tt> of OpenSim.ini.<br />
Parameters: USER, PASS
<nowiki>http://foo.bar:8002/StartSession/</nowiki>
Return: (XML) <ConsoleSession><SessionID></SessionID><Prompt></Prompt></ConsoleSession>

Now we got the SessionID, which can be used to send a command and to receive output. First, retrieve the console scrollback buffer.<br />
Parameters: none
<nowiki>http://foo.bar:8002/ReadResponses/<SessionID>/</nowiki>
Return: (XML) <ConsoleSession><Line Number=x Level=l Prompt=p Command=c Input=i></Line></ConsoleSession><br />
The reply contains all lines currently in the buffer. Subsequent fetches will only retrieve new lines. The fetch will hold for up to 30 seconds if there is no data, then return an error. The client is expected to try again (polling).
The attributes are as follows:
Number = The line number (1 based)
Level = The level this is to be logged as
Prompt = bool, true if the output on this line is a prompt
Command = bool, true if the prompt is for a command
Input = bool, true if the output is eachoed input

Use the SessionID as ID parameter, and send a POST request again.<br />
Parameters: ID, COMMAND
<nowiki>http://foo.bar:8002/SessionCommand/</nowiki>
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession><br />
If everything went well, the command should have been executed. Try another command.

When you want to close down the connection, send a POST request again.<br />
Parameters: ID
<nowiki>http://foo.bar:8002/CloseSession/</nowiki>
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession><br />
The session is closed, and you have to log in again, when you want to send a command again.

= Clients =

== C# ==

A C# client is included with the Opensimulator distribution. It is rudimentary and not updated to the latest protocol versions.

== Qt ==

The Qt 5 based client is at https://github.com/MelanieT/OpenSimConsoleClient

= Binaries =
Windows: http://opensimulator.org/downloads/ConsoleClient.zip
Mac: http://opensimulator.org/downloads/ConsoleClient.dmg
Linux: TBD

= Examples =

== NOTE ==

The below examples are for an older version of the interface. They may work to a degree but need to be revised.

=== node.js ===

<source lang="javascript">
/*
| This piece of code is published by thomax (txOh) (c) 2018 under the
| Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)
|
| I removed my previous python approach because blueman made a better
| version and it was outdated. Here is a node.js variant.
*/

const readline = require('readline');
var Client = require('node-rest-client').Client;
var client = new Client();
var session_id;
var base_url = "http://127.0.0.1:9000";

// set http header
var headers = {
"Content-Type": "application/x-www-form-urlencoded",
"User-Agent": "nodejs-console/0.01"
};

// open session
function open_session() {
var args = {
data: {
"USER": "Test",
"PASS": 'secret'
},
headers,
};

client.post(base_url + "/StartSession/", args, function (data, response) {
session_id = data.ConsoleSession.SessionID;
read_session_buffer();
});
}

// close session
function close_session() {
args = {
data: { "ID": session_id },
headers
};

client.post(base_url + "/CloseSession/", args, function (data, response) {
console.log("close_session: "+response);
});

console.log('Have a great day!');
process.exit(0);
}

// read all the lines from the console buffer and print them
function read_session_buffer() {
args = {
data: { "ID": session_id },
headers
};

client.post(base_url + "/ReadResponses/"+session_id+"/", args, function (data, response) {
if(data.ConsoleSession.Line) {
var i;
for(i=0; i < data.ConsoleSession.Line.length; i++) {
if(data.ConsoleSession.Line[i]._) {
console.log(data.ConsoleSession.Line[i]._);
}
}
rl.prompt();
}
});
}

// execute the command from the prompt
function execute_cmd(cmd) {
args = {
data: {
"ID": session_id,
"COMMAND": cmd
},
headers
};

client.post(base_url + "/SessionCommand/", args, function (data, response) {
});
}

// here we go.
open_session();

// prepare readline
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout,
prompt: 'REST CONSOLE> '
});
rl.prompt();

// hunt for events
rl.on('line', (line) => {
switch (line.trim()) {
case 'quit':
close_session();
break;
default:
if(line.length > 0) {
execute_cmd(line.trim());
}
break;
}
read_session_buffer();
rl.prompt();
}).on('close', () => {
close_session();
});

=== Python (Updated) ===

<source lang="python">
#!/usr/bin/python
# This piece of code is published by thomax (txOh) (c) 2010 under the
# Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)
# Modifications (c) 2013 BlueWall

import urllib, urllib2
import xml.dom.minidom

class UserConsoleClient():

def __init__(self, addr):
self.addr = addr
url = self.addr + 'StartSession/'

params = urllib.urlencode({
'USER': 'username', # REST username
'PASS': 'userpass' # REST password
})
data = urllib2.urlopen(url, params).read()
print data

dom = xml.dom.minidom.parseString(data)
elem = dom.getElementsByTagName('SessionID')
self.sessionid = elem[0].childNodes[0].nodeValue
elem = dom.getElementsByTagName('Prompt')
self.prompt = elem[0].childNodes[0].nodeValue + '# '

def close(self):
url = self.addr + 'CloseSession/'
params = urllib.urlencode({
'ID': self.sessionid
})
print urllib2.urlopen(url, params).read()

def do_cmd(self, cmd):
url = self.addr + 'SessionCommand/'
params = urllib.urlencode({
'ID': self.sessionid,
'COMMAND': cmd
})
data = urllib2.urlopen(url, params).read()
dom = xml.dom.minidom.parseString(data)
elem = dom.getElementsByTagName('Result')
return elem[0].childNodes[0].nodeValue

def read_buffer(self):
url = self.addr + 'ReadResponses/' + self.sessionid + '/'
params = urllib.urlencode({
'ID': self.sessionid
})

# print urllib2.urlopen(url, params).read()

result = urllib2.urlopen(url, params).read()
dom = xml.dom.minidom.parseString(result)

elem = dom.getElementsByTagName('Line')
for line in elem:
x0 = line.childNodes[0].nodeValue
x1 = str.replace(str(x0),':','~',2)
x2 = x1.split("~")
for lv in x2[2:]:
if not '+++' in lv:
print lv

# set the base url to the REST console (with port)
console = UserConsoleClient('http://example.com:8003/')
console.read_buffer()
print 'quit with a "."'
cmd = ""
while cmd != ".":
if cmd != "":
if 'OK' in console.do_cmd(cmd):
console.read_buffer()
cmd = raw_input("%s " % console.prompt)

console.close()

</source>

=== JavaScript/HTML ===

<pre>
<html>
<head>




<script type="text/javascript">

var sessionId;
var hostUrl;

function StartSession(url, user, password) {
hostUrl = url;
var response = SendRequest("/StartSession/", "USER=" + user + "&PASS=" + password);
sessionId = response.getElementsByTagName("SessionID")[0].firstChild.nodeValue;
};

function ReadResponses() {
var response = this.SendRequest("/ReadResponses/" + sessionId + "/", '');
var lines = response.getElementsByTagName("Line");
for (var i = 0; i < lines.length; ++i) {
var element = document.createElement("div");
element.appendChild(document.createTextNode(lines[i].firstChild.nodeValue));
document.getElementById("output").appendChild(element);
};
document.getElementById("output").scrollTop = document.getElementById("output").scrollHeight;
};

function Command(cmd) {
void SendRequest("/SessionCommand/", "ID=" + sessionId + "&COMMAND=" + cmd);
};

function CloseSession() {
void SendRequest("/CloseSession/", "ID=" + sessionId);
};

function SendRequest(path, data) {
var request = new XMLHttpRequest();
request.open("POST", hostUrl + path, false);
request.send(data);
return request.responseXML;
};

window.onunload = CloseSession;

</script>
</head>
<body>

<form action="#" onsubmit="
StartSession(this.address.value, this.user.value, this.password.value);
ReadResponses();
return false">
<input name="address" type="text" value="http://localhost:9000" />
<input name="user" type="text" value="ConsoleUser" />
<input name="password" type="text" value="ConsolePass" />
<input type="submit" value="Login" />
</form>

<div id="output" style="height:15em; border:thin solid; overflow:auto;"></div>

<form action="#" onsubmit="
Command(this.command.value);
ReadResponses();
return false">
<input type="text" name="command" value="Enter command here" size="40"/>
<input type="submit" value="Send Command" />
</form>

</body>
</html>
</pre>

Compatible Viewers

2013-05-25T05:52:09Z

Thomax: /* Feature Table */

{{thirdparty}}

If you find a viewer which can connect to OpenSimulator then please add it to the bottom of the appropriate list.

= Viewers with Grid Selector and Grid Manager =

Below are viewers that have both a grid selector and a "Grid Manager". It enables you to select one of the many [[Grid List|grids]], including a grid or region on localhost (your own PC). There is also a UI interface to allow you to modify or add connection settings to these grids.

* [http://hypergrid.org/metropolis/wiki/en/index.php/Downloads Hippo Viewer] - a fork of version 1.23 of the Linden Client with OpenSimulator specific enhancements
* [http://imprudenceviewer.org/ Imprudence] Innovative viewer with a high focus on OpenSimulator (good [[OSSL]] support). Highly popular amongst users on [[Grid List/OSGrid|OSGrid]].
* [http://www.phoenixviewer.com/ Firestorm viewer] v3 based TPV, the successor to Phoenix. The most widely used viewer on Second Life, with the best features from Phoenix. OpenSimulator is fully supported with its own version.
* [http://www.phoenixviewer.com/ Phoenix Viewer] Based on the now discontinued Emerald Viewer (which was based on the 1.23 LL viewer), one of the most popular viewers. Combines many improvements and features from different viewers. (No longer supported)
* [http://www.singularityviewer.org/ Singularity] - A V1 based viewer, with all the good stuff from v2/3 added. Supports [[Mesh]], [[OSSL]], [[LightShare]], Alpha, Tattoos and Physics, multiple attachments per joint, multiple clothing layers, inventory links, etc...
* [http://sldev.free.fr/ Cool VL Viewer] - the oldest of all actively maintained Third Party Viewers (former name: Cool SL Viewer), fully OpenSimulator compatible. It also got support for [[Mesh]], Alpha, Tattoos and Physics, multiple attachments per joint, multiple clothing layers, inventory links, etc...
* [http://lumiyaviewer.com Lumiya viewer] - A Second Life and OpenSimulator viewer for Android.

= Viewers with Grid Selector Only =

These viewers don't have a Grid Manager, but you can a grid from a list, including localhost. You may need to manually edit a configuration file in order to connect to grids that are not originally included.

* [http://imprudenceviewer.org/ Kokua] v2/3 based successor of Imprudence. Currently in alpha/experimental stage.

= Viewers without Grid Selector =

'''Note: After LL 3.3.4, the --loginuri parameter was removed from the official Linden viewer. There is now no simple way to use this viewer to log in to OpenSimulator.'''. You will need to launch this viewer with a --loginuri command line parameter to connect to OpenSimulator grids. See [http://wiki.secondlife.com/wiki/Viewer_parameters] for the syntax of this command, or visit the support section on the homepage of your preferred grid.

* [http://secondlife.com/support/downloads/ Second Life Viewer]

= Text-only Viewers =
These are lightweight viewers, which either do not offer a graphical component or where the graphical component is not used by deault. The function of these viewers however is to connect to a grid, chat, manage inventory, etc. Useful on systems with low specifications or for bringing an alt online without having your main avatar log out, or to quickly take care of messages, inventory, etc.

* [http://radegast.org Radegast Metaverse Client] Works with OpenSim-based grids, as well as with SL. Has Windows, MacOS and Linux versions.
* [https://bitbucket.org/jchauhan/jopenmetaverse JOpenMetaverse] Purely Java based OpenSim client core library. Windows, MacOS,, Linux and Android Compatible. Please see [http://www.slideshare.net/jchauhan/jopenmeraverse-introduction jopenmetaverse introduction]

= Inactive Viewers =
* [[RealXtend]] - a fork of the 1.23 Linden Client that has specialized features (not fully supported.)
* [http://forge.opensimulator.org/gf/project/idealistviewer/ Idealist viewer]
* [http://3di-rei.org/ 3Di viewer]
* [[Xenki]], an XBAP 3D application intended to be a browser add-on for OpenSimulator.
* [http://lookingglassviewer.org/wiki/Main_Page Looking Glass viewer], Discontinued. Only OSGrid, ScienceSim and localhost are available from the list.
* [http://dolphinviewer.eregion.de/ Dolphin Viewer] v3 based viewer, but v1 and v2 based versions are also available. Contains modifications which are useful for building, sailing, and for using vehicles. '''No longer supports OpenSimulator with new versions due to LL licensing changes and code constraints. Last version 3.3.19 that works with OpenSimulator still available.

= Feature Table =

{| cellspacing="0" cellpadding="5" border="1" align="center" class="sortable"
|-
| '''Viewer<br />Name'''
| Based on Version
| Grid<br />Selector
| Grid<br />Manager
| Graphical
| Mesh
| [[:Category:OSSL|OSSL]]<br />support
| LightShare [[#note1|[1]]]
| Parcel<br />Windlight [[#note2|[2]]]
| Multiple<br />Attachments
| Multiple<br />Clothing<br />Layers
| Operating System
| '''Notes'''
|-
| [http://realxtend.wordpress.com/download/ RealXtend Naali]
| n/a
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]]
| [[#note3|[3]]]
|-
| [http://forge.opensimulator.org/gf/project/opensim-viewer/frs/ Hippo Viewer]
| v1
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  
|-
| [http://wiki.kokuaviewer.org/wiki/Downloads Imprudence]
| v1
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|frameless|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  
|-
| [http://www.phoenixviewer.com/ Phoenix Viewer]
| v1
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  
|-
| [http://www.singularityviewer.org/downloads Singularity]
| v1
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  
|-
| [http://sldev.free.fr/ Cool VL Viewer]
| v1
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  
|-
| [http://wiki.kokuaviewer.org/wiki/Kokua:Experimental Kokua]
| v2/3
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]] [[Image:Tux.png|24px|frameless|Linux version available]]
| [[#note4|[4]]]
|-
| [http://lookingglassviewer.org/wiki/Download Looking Glass viewer]
| ?
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]]
|  
|-
| [http://secondlife.com/support/downloads/ Second Life Viewer]
| v2/3
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  
|-
| [http://www.phoenixviewer.com/ Firestorm viewer]
| v2/3
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  
|-
| [http://radegast.org/wiki/Radegast_Download Radegast Metaverse Client]
| n/a
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:white;text-align:center;" | Text client<br />with graphical<br />component
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:white;text-align:center;" | ?
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  
|-
| [http://forge.opensimulator.org/gf/project/idealistviewer/ Idealist viewer]
| ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="text-align:right;" |  
| [[#note5|[5]]]
|-
| [http://3di-rei.org/home/downloads/index.html 3Di viewer]
| Browser
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]]
|  
|-
| [http://forge.opensimulator.org/gf/project/xenki/ Xenki]
| Browser
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="text-align:right;" |  
| [[#note5|[5]]]
|-
| [http://dolphinviewer.eregion.de/2012/08/18/dolphin-viewer-and-support-for-opensim/ OpenDolphin Viewer]
| v1/2/3
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √ (v2/3)
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √ (v2/3)
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  

|}

:'''Notes'''
----
* '''<span id="note1">#1</span>''' LightShare is a method for altering WindLight settings on a parcel or region by means of a script. See [[Lightshare]].
* '''<span id="note2">#2</span>''' The Parcel Windlight referred to here, is a Phoenix/Firestorm feature which lets parcel owners define a windlight setting which is to be applied to a user's viewer if the viewer supports it, and if the visitor has enabled that feature. See [http://wiki.phoenixviewer.com/doku.php?id=parcelwl the Parcel WL article on the Phoenix wiki] for more info.
* '''<span id="note3">#3</span>''' RealXtend requires an additional module to be active on OpenSimulator. See [[ModRex]].
* '''<span id="note4">#4</span>''' Data based on Kokua-3.5.2 [http://wiki.kokuaviewer.org/wiki/Kokua:Experimental], may soon be out of date!
* '''<span id="note5">#5</span>''' Only source code is provided. No precompiled binaries!
----
<br />

Compatible Viewers

2013-05-25T05:49:52Z

Thomax: /* Feature Table */ updated kokua informations

{{thirdparty}}

If you find a viewer which can connect to OpenSimulator then please add it to the bottom of the appropriate list.

= Viewers with Grid Selector and Grid Manager =

Below are viewers that have both a grid selector and a "Grid Manager". It enables you to select one of the many [[Grid List|grids]], including a grid or region on localhost (your own PC). There is also a UI interface to allow you to modify or add connection settings to these grids.

* [http://hypergrid.org/metropolis/wiki/en/index.php/Downloads Hippo Viewer] - a fork of version 1.23 of the Linden Client with OpenSimulator specific enhancements
* [http://imprudenceviewer.org/ Imprudence] Innovative viewer with a high focus on OpenSimulator (good [[OSSL]] support). Highly popular amongst users on [[Grid List/OSGrid|OSGrid]].
* [http://www.phoenixviewer.com/ Firestorm viewer] v3 based TPV, the successor to Phoenix. The most widely used viewer on Second Life, with the best features from Phoenix. OpenSimulator is fully supported with its own version.
* [http://www.phoenixviewer.com/ Phoenix Viewer] Based on the now discontinued Emerald Viewer (which was based on the 1.23 LL viewer), one of the most popular viewers. Combines many improvements and features from different viewers. (No longer supported)
* [http://www.singularityviewer.org/ Singularity] - A V1 based viewer, with all the good stuff from v2/3 added. Supports [[Mesh]], [[OSSL]], [[LightShare]], Alpha, Tattoos and Physics, multiple attachments per joint, multiple clothing layers, inventory links, etc...
* [http://sldev.free.fr/ Cool VL Viewer] - the oldest of all actively maintained Third Party Viewers (former name: Cool SL Viewer), fully OpenSimulator compatible. It also got support for [[Mesh]], Alpha, Tattoos and Physics, multiple attachments per joint, multiple clothing layers, inventory links, etc...
* [http://lumiyaviewer.com Lumiya viewer] - A Second Life and OpenSimulator viewer for Android.

= Viewers with Grid Selector Only =

These viewers don't have a Grid Manager, but you can a grid from a list, including localhost. You may need to manually edit a configuration file in order to connect to grids that are not originally included.

* [http://imprudenceviewer.org/ Kokua] v2/3 based successor of Imprudence. Currently in alpha/experimental stage.

= Viewers without Grid Selector =

'''Note: After LL 3.3.4, the --loginuri parameter was removed from the official Linden viewer. There is now no simple way to use this viewer to log in to OpenSimulator.'''. You will need to launch this viewer with a --loginuri command line parameter to connect to OpenSimulator grids. See [http://wiki.secondlife.com/wiki/Viewer_parameters] for the syntax of this command, or visit the support section on the homepage of your preferred grid.

* [http://secondlife.com/support/downloads/ Second Life Viewer]

= Text-only Viewers =
These are lightweight viewers, which either do not offer a graphical component or where the graphical component is not used by deault. The function of these viewers however is to connect to a grid, chat, manage inventory, etc. Useful on systems with low specifications or for bringing an alt online without having your main avatar log out, or to quickly take care of messages, inventory, etc.

* [http://radegast.org Radegast Metaverse Client] Works with OpenSim-based grids, as well as with SL. Has Windows, MacOS and Linux versions.
* [https://bitbucket.org/jchauhan/jopenmetaverse JOpenMetaverse] Purely Java based OpenSim client core library. Windows, MacOS,, Linux and Android Compatible. Please see [http://www.slideshare.net/jchauhan/jopenmeraverse-introduction jopenmetaverse introduction]

= Inactive Viewers =
* [[RealXtend]] - a fork of the 1.23 Linden Client that has specialized features (not fully supported.)
* [http://forge.opensimulator.org/gf/project/idealistviewer/ Idealist viewer]
* [http://3di-rei.org/ 3Di viewer]
* [[Xenki]], an XBAP 3D application intended to be a browser add-on for OpenSimulator.
* [http://lookingglassviewer.org/wiki/Main_Page Looking Glass viewer], Discontinued. Only OSGrid, ScienceSim and localhost are available from the list.
* [http://dolphinviewer.eregion.de/ Dolphin Viewer] v3 based viewer, but v1 and v2 based versions are also available. Contains modifications which are useful for building, sailing, and for using vehicles. '''No longer supports OpenSimulator with new versions due to LL licensing changes and code constraints. Last version 3.3.19 that works with OpenSimulator still available.

= Feature Table =

{| cellspacing="0" cellpadding="5" border="1" align="center" class="sortable"
|-
| '''Viewer<br />Name'''
| Based on Version
| Grid<br />Selector
| Grid<br />Manager
| Graphical
| Mesh
| [[:Category:OSSL|OSSL]]<br />support
| LightShare [[#note1|[1]]]
| Parcel<br />Windlight [[#note2|[2]]]
| Multiple<br />Attachments
| Multiple<br />Clothing<br />Layers
| Operating System
| '''Notes'''
|-
| [http://realxtend.wordpress.com/download/ RealXtend Naali]
| n/a
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]]
| [[#note3|[3]]]
|-
| [http://forge.opensimulator.org/gf/project/opensim-viewer/frs/ Hippo Viewer]
| v1
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  
|-
| [http://wiki.kokuaviewer.org/wiki/Downloads Imprudence]
| v1
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|frameless|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  
|-
| [http://www.phoenixviewer.com/ Phoenix Viewer]
| v1
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  
|-
| [http://www.singularityviewer.org/downloads Singularity]
| v1
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  
|-
| [http://sldev.free.fr/ Cool VL Viewer]
| v1
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  
|-
| [http://wiki.kokuaviewer.org/wiki/Kokua:Experimental Kokua]
| v2/3
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="text-align:right;" | [[Image:Tux.png|24px|frameless|Linux version available]]
| [[#note4|[4]]]
|-
| [http://lookingglassviewer.org/wiki/Download Looking Glass viewer]
| ?
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]]
|  
|-
| [http://secondlife.com/support/downloads/ Second Life Viewer]
| v2/3
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  
|-
| [http://www.phoenixviewer.com/ Firestorm viewer]
| v2/3
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  
|-
| [http://radegast.org/wiki/Radegast_Download Radegast Metaverse Client]
| n/a
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:white;text-align:center;" | Text client<br />with graphical<br />component
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:white;text-align:center;" | ?
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  
|-
| [http://forge.opensimulator.org/gf/project/idealistviewer/ Idealist viewer]
| ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="text-align:right;" |  
| [[#note5|[5]]]
|-
| [http://3di-rei.org/home/downloads/index.html 3Di viewer]
| Browser
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]]
|  
|-
| [http://forge.opensimulator.org/gf/project/xenki/ Xenki]
| Browser
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="background-color:white;text-align:center;" | ?
| style="text-align:right;" |  
| [[#note5|[5]]]
|-
| [http://dolphinviewer.eregion.de/2012/08/18/dolphin-viewer-and-support-for-opensim/ OpenDolphin Viewer]
| v1/2/3
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √ (v2/3)
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:red;text-align:center;" | X
| style="background-color:chartreuse;text-align:center;" | √
| style="background-color:chartreuse;text-align:center;" | √ (v2/3)
| style="text-align:right;" | [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
|  

|}

:'''Notes'''
----
* '''<span id="note1">#1</span>''' LightShare is a method for altering WindLight settings on a parcel or region by means of a script. See [[Lightshare]].
* '''<span id="note2">#2</span>''' The Parcel Windlight referred to here, is a Phoenix/Firestorm feature which lets parcel owners define a windlight setting which is to be applied to a user's viewer if the viewer supports it, and if the visitor has enabled that feature. See [http://wiki.phoenixviewer.com/doku.php?id=parcelwl the Parcel WL article on the Phoenix wiki] for more info.
* '''<span id="note3">#3</span>''' RealXtend requires an additional module to be active on OpenSimulator. See [[ModRex]].
* '''<span id="note4">#4</span>''' Data based on Kokua-3.0.0-WIP [http://wiki.kokuaviewer.org/wiki/Kokua:Experimental], may soon be out of date!
* '''<span id="note5">#5</span>''' Only source code is provided. No precompiled binaries!
----
<br />

User:Thomax:nat-loopback

2010-12-05T10:27:54Z

Thomax:

== NAT Loopback Configuration on OpenWRT ==

Well, first is this little script, which should be placed in ''/etc/firewall.user'':

<pre>
# get the WANIP from the ppp0 interface
WANIP=`ifconfig ppp0 | awk '/inet addr/ {split ($2,A,":"); print A[2]}'`

# my lan ip
LANIP = 192.168.1.100

nat_loopback() {
iptables -t nat -A prerouting_rule -d $WANIP -p $3 --dport $1 -j DNAT --to $2
iptables -A forwarding_rule -p $3 --dport $1 -d $2 -j ACCEPT
iptables -t nat -A postrouting_rule -s 192.168.1.0/24 -p $3 --dport $1 -d $2 -j MASQUERADE
}

# thats for a local apache (yepp, i have a local web server..)
nat_loopback 80 $LANIP tcp

# http_listen_port from the OpenSim.ini
nat_loopback 9000 $LANIP tcp

# and the udp port of the region (RegionConfig.ini)
nat_loopback 19010 $LANIP udp
</pre>

And just because I have a dynamic IP address I need to be sure that the firewall rules get reloaded on each new PPPoE connect. Thats why I created the script ''/etc/ppp/ip-up.d/connect.sh''
which looks like this:

<pre>
#!/bin/sh

# Put stuff here you need todo just when your router reconnects to the provider

/etc/init.d/firewall reload
</pre>

Thats what I've additionally done beside the normal LuCI settings on my openWRT router, which is an asus wl-500gP (with this nice two USB slots :-)

Let me know if it helps you too...

thomax

User:Thomax:nat-loopback

2010-12-05T10:27:32Z

Thomax:

NAT Loopback Configuration on OpenWRT

Well, first is this little script, which should be placed in ''/etc/firewall.user'':

<pre>
# get the WANIP from the ppp0 interface
WANIP=`ifconfig ppp0 | awk '/inet addr/ {split ($2,A,":"); print A[2]}'`

# my lan ip
LANIP = 192.168.1.100

nat_loopback() {
iptables -t nat -A prerouting_rule -d $WANIP -p $3 --dport $1 -j DNAT --to $2
iptables -A forwarding_rule -p $3 --dport $1 -d $2 -j ACCEPT
iptables -t nat -A postrouting_rule -s 192.168.1.0/24 -p $3 --dport $1 -d $2 -j MASQUERADE
}

# thats for a local apache (yepp, i have a local web server..)
nat_loopback 80 $LANIP tcp

# http_listen_port from the OpenSim.ini
nat_loopback 9000 $LANIP tcp

# and the udp port of the region (RegionConfig.ini)
nat_loopback 19010 $LANIP udp
</pre>

And just because I have a dynamic IP address I need to be sure that the firewall rules get reloaded on each new PPPoE connect. Thats why I created the script ''/etc/ppp/ip-up.d/connect.sh''
which looks like this:

<pre>
#!/bin/sh

# Put stuff here you need todo just when your router reconnects to the provider

/etc/init.d/firewall reload
</pre>

Thats what I've additionally done beside the normal LuCI settings on my openWRT router, which is an asus wl-500gP (with this nice two USB slots :-)

Let me know if it helps you too...

thomax

OsUnixTimeToTimestamp

2010-11-17T10:00:23Z

Thomax:

'''Function Syntax:''' osUnixTimeToTimestamp(integer epoch);<br>
'''Returns:''' string<br>
'''Threat Level:''' VeryLow

This function allows an input unix time to be converted to an llGetTimeStamp() format. Please note that there will be no second fractions. This is because the implementation works with seconds only.

Example:<br>

<source lang="lsl">
// prints something similar to this:
// [01:08] Primitive: 2010-11-13T09:08:53.6472090Z
// [01:08] Primitive: 2010-11-13T09:08:53.0000000Z
default
{
state_entry()
{
llOwnerSay(llGetTimestamp());
llOwnerSay(osUnixTimeToTimestamp((integer)llGetUnixTime()));
}
}
</source>

OsUnixTimeToTimestamp

2010-11-17T09:59:59Z

Thomax:

'''Function Syntax:''' osUnixTimeToTimestamp(integer epoch);<br>
'''Returns:''' string<br>
'''Function Threat Level:''' VeryLow

This function allows an input unix time to be converted to an llGetTimeStamp() format. Please note that there will be no second fractions. This is because the implementation works with seconds only.

Example:<br>

<source lang="lsl">
// prints something similar to this:
// [01:08] Primitive: 2010-11-13T09:08:53.6472090Z
// [01:08] Primitive: 2010-11-13T09:08:53.0000000Z
default
{
state_entry()
{
llOwnerSay(llGetTimestamp());
llOwnerSay(osUnixTimeToTimestamp((integer)llGetUnixTime()));
}
}
</source>

OsUnixTimeToTimestamp

2010-11-17T09:59:46Z

Thomax:

'''Function Syntax:''' osUnixTimeToTimestamp(integer epoch);<br>
'''Returns:''' string
'''Function Threat Level:''' VeryLow

This function allows an input unix time to be converted to an llGetTimeStamp() format. Please note that there will be no second fractions. This is because the implementation works with seconds only.

Example:<br>

<source lang="lsl">
// prints something similar to this:
// [01:08] Primitive: 2010-11-13T09:08:53.6472090Z
// [01:08] Primitive: 2010-11-13T09:08:53.0000000Z
default
{
state_entry()
{
llOwnerSay(llGetTimestamp());
llOwnerSay(osUnixTimeToTimestamp((integer)llGetUnixTime()));
}
}
</source>

OsUnixTimeToTimestamp

2010-11-17T09:56:05Z

Thomax:

'''Function Syntax:''' osUnixTimeToTimestamp(integer epoch);<br>
'''Returns:''' string

This function allows an input unix time to be converted to an llGetTimeStamp() format. Please note that there will be no second fractions. This is because the implementation works with seconds only.

Example:<br>

<source lang="lsl">
// prints something similar to this:
// [01:08] Primitive: 2010-11-13T09:08:53.6472090Z
// [01:08] Primitive: 2010-11-13T09:08:53.0000000Z
default
{
state_entry()
{
llOwnerSay(llGetTimestamp());
llOwnerSay(osUnixTimeToTimestamp((integer)llGetUnixTime()));
}
}
</source>

OsUnixTimeToTimestamp

2010-11-17T09:49:54Z

Thomax: new function documentation

'''Function Syntax:''' osUnixTimeToTimestamp(integer epoch);<br>
'''Returns:''' string

This function allows an input unix time to be converted to an llGetTimeStamp() format. Please note that there will be no second fractions. This is because the implementation works with seconds only.

Example:<br>

<source lang="lsl">
// prints something similar to this:
// [01:08] Primitive: 2010-11-13T09:08:53.6472090Z
// [01:08] Primitive: 2010-11-13T09:08:53.0000000Z
default
{
state_entry()
{
llOwnerSay(llGetTimestamp());
llOwnerSay(osEpochToString((integer)llGetUnixTime()));
}
}
</source>

OSSL Implemented

2010-11-17T09:41:13Z

Thomax: added link to osUnixTimeToTimestamp

__NOTOC__ {{Template:Quicklinks}} <br>[[Technical Reference|Technical Reference]] -> [[Technical Reference/terms|Terms]] -> [[Status|Status Page]] -> [[OSSL_Implemented|OSSL Implemented Functions]]

 {{content}}

== Current OSSL Functions Implemented ==

Updated October.21.2010 From OpenSimulator Master/Dev Source.

Special Note:   Some Functions as shown use '''"double"''' as a Value instead of '''"float" '''these vary for purposes of accuracy as shown Below. 

(Float is short for "floating point", and just means a number with a point something on the end.)

The difference between the two is in the size of the numbers that they can hold. For float, you can have up to 7 digits in your number. For doubles, you can have up to 16 digits. To be more precise, here's the official size: ( float: 1.5 × 10-45 to 3.4 × 1038 ) ( double: 5.0 × 10-324 to 1.7 × 10308 )

Each of these functions has an threat level associated to it. See [[Threat level]] for more information and an overview of each function's level.

<br>

*[[OsAvatarName2Key|OsAvatarName2Key]]
*[[OsAvatarPlayAnimation|OsAvatarPlayAnimation]]
*[[OsAvatarStopAnimation|OsAvatarStopAnimation]]
*[[OsCauseDamage|OsCauseDamage]]
*[[OsCauseHealing|OsCauseHealing]]
*[[OsConsoleCommand|OsConsoleCommand]]
*[[OsDrawEllipse|OsDrawEllipse]]
*[[OsDrawFilledPolygon|OsDrawFilledPolygon]]
*[[OsDrawFilledRectangle|OsDrawFilledRectangle]]
*[[OsDrawImage|OsDrawImage]]
*[[OsDrawLine|OsDrawLine]]
*[[OsDrawPolygon|OsDrawPolygon]]
*[[OsDrawRectangle|OsDrawRectangle]]
*[[OsDrawText|OsDrawText]]
*[[OsFormatString|OsFormatString]]
*[[OsGetAgentIP|OsGetAgentIP]]
*[[OsGetAgents|OsGetAgents]]
*[[OsGetAvatarList|OsGetAvatarList]]
*[[OsGetCurrentSunHour|OsGetCurrentSunHour]]
*[[OsGetDrawStringSize|OsGetDrawStringSize]]
*[[OsGetGridLoginURI|OsGetGridLoginURI]]
*[[OsGetGridName|OsGetGridName]]
*[[OsGetGridNick|OsGetGridNick]]
*[[OsGetLinkPrimitiveParams|OsGetLinkPrimitiveParams]]
*[[OsGetMapTexture|OsGetMapTexture]]
*[[OsGetNotecard|OsGetNotecard]]
*[[OsGetNotecardLine|OsGetNotecardLine]]
*[[OsGetNumberOfNotecardLines|OsGetNumberOfNotecardLines]]
*[[OsGetPrimitiveParams|OsGetPrimitiveParams]]
*[[OsGetRegionMapTexture|OsGetRegionMapTexture]]
*[[OsGetRegionStats|OsGetRegionStats]]
*[[OsGetScriptEngineName|OsGetScriptEngineName]]
*[[OsGetSimulatorMemory|OsGetSimulatorMemory]]
*[[OsGetSimulatorVersion|OsGetSimulatorVersion]]
*[[OsKey2Name|OsKey2Name]]
*[[OsKickAvatar|OsKickAvatar]]
*[[OsList2Double|OsList2Double]]
*[[OsLoadedCreationDate|OsLoadedCreationDate]]
*[[OsLoadedCreationID|OsLoadedCreationID]]
*[[OsLoadedCreationTime|OsLoadedCreationTime]]
*[[OsMakeNotecard|OsMakeNotecard]]
*[[OsMatchString|OsMatchString]]
*[[OsMessageObject|OsMessageObject]]
*[[OsMovePen|OsMovePen]]
*[[OsNpcCreate|OsNpcCreate]]
*[[OsNpcMoveTo|OsNpcMoveTo]]
*[[OsNpcRemove|OsNpcRemove]]
*[[OsNpcSay|OsNpcSay]]
*[[OsParcelJoin|OsParcelJoin]]
*[[OsParcelSetDetails|OsParcelSetDetails]]
*[[OsParcelSubdivide|OsParcelSubdivide]]
*[[OsParseJSON|OsParseJSON]]
*[[OsRegionNotice|OsRegionNotice]]
*[[OsRegionRestart|OsRegionRestart]]
*[[OsSetDynamicTextureData|OsSetDynamicTextureData]]
*[[OsSetDynamicTextureDataBlend|OsSetDynamicTextureDataBlend]]
*[[OsSetDynamicTextureDataBlendFace|OsSetDynamicTextureDataBlendFace]]
*[[OsSetDynamicTextureURL|OsSetDynamicTextureURL]]
*[[OsSetDynamicTextureURLBlend|OsSetDynamicTextureURLBlend]]
*[[OsSetDynamicTextureURLBlendFace|OsSetDynamicTextureURLBlendFace]]
*[[OsSetEstateSunSettings|OsSetEstateSunSettings]]
*[[OsSetFontName|OsSetFontName]]
*[[OsSetFontSize|OsSetFontSize]]
*[[OsSetParcelMediaURL|OsSetParcelMediaURL]]
*[[osSetParcelSIPAddress|OsSetParcelSIPAddress]]
*[[OsSetPenCap|OsSetPenCap]]
*[[OsSetPenColour|OsSetPenColour]]
*[[OsSetPenSize|OsSetPenSize]]
*[[OsSetPrimFloatOnWater|OsSetPrimFloatOnWater]]
*[[OsSetPrimitiveParams|OsSetPrimitiveParams]]
*[[OsSetProjectionParams|OsSetProjectionParams]]
*[[OsSetRegionSunSettings|OsSetRegionSunSettings]]
*[[OsSetRegionWaterHeight|OsSetRegionWaterHeight]]
*[[OsSetSpeed|OsSetSpeed]]
*[[OsSetStateEvents|OsSetStateEvents]]
*[[OsSunGetParam|OsSunGetParam]]
*[[OsSunSetParam|OsSunSetParam]]
*[[OsTeleportAgent|OsTeleportAgent]]
*[[OsTeleportOwner|OsTeleportOwner]]
*[[OsTerrainFlush|OsTerrainFlush]]
*[[OsTerrainGetHeight|OsTerrainGetHeight]]
*[[OsTerrainSetHeight|OsTerrainSetHeight]]
*[[OsUnixTimeToTimestamp|OsUnixTimeToTimestamp]]
*[[OsWindActiveModelPluginName|OsWindActiveModelPluginName]]
*[[OsWindParamGet|OsWindParamGet]]
*[[OsWindParamSet|OsWindParamSet]]

<br>

== See Also ==

*[[LSL Status|LSL/OSSL Status Page]]
*LSL
**[[LSL Status/Types|LSL Types Status Page]]
**[[LSL Status/Events|LSL Events Status Page]]
**[[LSL Status/Functions|LSL Functions Status Page]]
**[[LSL Status/functions/summary|LSL Functions Status Summary]]
**[[LSL Known Issues|LSL Known Issues]]
**[[Kan-Ed Tests|Kan-Ed Tests]]
*OSSL
**[[OSSL Status/Types|OSSL Types Status Page]]
**[[OSSL Status/Events|OSSL Events Status Page]]
**[[OSSL Proposals|OSSL Proposed Functions]]
**[[OSSL_Implemented|OSSL Implemented Functions]]
**[[OSSL Enabling Functions]]
**[[OSSL Standards|OSSL Standards]]
*[[Technical Reference|Technical Reference Page]]

[[Category:Users]] [[Category:Support]] [[Category:Tech_Reference]] [[Category:Help]] [[Category:Configuration]] [[Category:Getting_Started]] [[Category:Development]] [[Category:Todo]] [[Category:Proposal]]

NAT Loopback Routers

2010-08-29T17:16:20Z

Thomax:

{{Template:Quicklinks}} {{content}}

=INTRODUCTION=

What is NAT Loopback and why is it needed to host a public Opensimulator Region?

Currently (as at August 2010), a hosted region on a home connection with a broadband router needs, what is known as ''NAT Loopback'' functionality.

Many DSL routers/modems prevent loopback connections as a security feature. This means that a NATed IP address ( such as 192.168.2.40 ) can not connect to your forward facing IP address ( such as 199.149.252.44 ) from behind your DSL router/modem. In a case like this, external IP addresses may connect to your server/region but you can not ( this applies to both standalone and grid modes ).

Symptoms of not having NAT Loopback is you can host a completely internal region (ie the region and asset database are all on one machine) and login, but someone outside can't login, even though you have set up your region.ini with your outside IP and forwarded the correct ports.

This page shows a list of routers supporting NAT Loopback feature in order to be able to TP in your region when you host it at home on the same computer or local network. Please add both known working and known non-working routers to the list.

=Working Routers=
==D-Link==

D-Link DGL-4500 series of routers have the largest available nat table of any router on the market.  These routers range from 70$-180$ USD depending on where you live and purchase from.

When considering a purchase, consider performance against cost. Upper end ADSL 2+ routers can add several Mbs to your modems sync speed.

*[http://www.dlink.com/products/?pid=64 D-Link DGL-4500]
*[http://www.dlink.com/products/?pid=530 D-Link DIR-655]
*[http://www.dlink.com/products/?pid=DIR-635 D-Link DIR-635]
*[http://www.dlink.com/products/?pid=DIR-601 D-Link DIR-601]
*[http://www.dlink.com/products/?pid=DIR-600 D-Link DIR-600]
*D-Link DI-524

Note: The DGL-4100 & DGL-4300 have been discontinued, and the replacement model is the DIL-825 and DIL-855 - Loopback status unknown on these later models. The DGL-4300 may be available second hand.

==Draytek==

* Draytek Vigor 2710n [http://www.draytek.com/user/PdInfoDetail.php?Id=82] does NAT loopback out of the box and seems to be generally an all-round great router.

==Netgear==

*NETGEAR WNR834M : ftp://downloads.netgear.com/files/wnr834m_ref_manual.pdf
*NETGEAR WNR2000 : With firmware 1.2.3.7 ( http://kb.netgear.com/app/answers/detail/a_id/11895 ) loopback now enabled 'out of the box'
*NETGEAR WGR614 : has been confirmed to work out of the box
*Netgear RP614 v3

==Linksys/Cisco==

*[http://www.linksysbycisco.com/EU/en/support/WAG200G Linksys WAG200G] with Firmware Version: 1.01.09
*[http://en.wikipedia.org/wiki/Linksys_WRT54G_series Linksys WRT54G]
*[http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G Linksys WAG54G v3]
*[http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G Linksys WAG54G v2 - NZ/Australia version]
*Linksys RT31P2
Note: The WAG54G v2 NZ/Australia version has a faster processor, more memory and larger NAT table, and works with OS out of the box. Other market versions may not.

==3Com==

*3CRWDR100A-72
*3CRWDR101A-75

==Zyxel==

* If you are using a ZyXEL DSL router/modem from Embarq, please read [http://opensimulator.org/wiki/OpenSim:Network_settings#A_solution_for_local_connections_when_you_are_using_NAT_and_Port_Forwarding this configuration guide]. This will show you how to reconfigure your DSL router/modem to fix this problem.

==Other routers & Hardware==

*Arris TM502b : http://portforward.com/english/routers/port_forwarding/Arris/TM502b/
*2wire 2701hg-s NOT Loopback capable. but the 2wire 2701hg-B & 2701hg-D Series ARE loopback capable.  (These can be purchased for approximately $50 USD)
*Thompson SpeedTouch router-modem ST-585i (requires Telnet acces to it to Enable Loopback)
*Thompson Speedtouch ST-780, ST-516
*AVM FritzBox (all Models working perfect) : http://www.avm.de
*Ubee Wireless Cable Router DDW2600  [http://www.ubeeinteractive.com/index.php/products/product-overview/wireless_cable_router1/ http://www.ubeeinteractive.com/index.php/products/product-overview/wireless_cable_router1/]
*BT home hub V2

=KNOWN non-functional for OpenSim:=

*Netgear Pro Safe VPN FVS318 : [http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx]
*NetGear WGR614 does not work with ISP required gateway modems
*Belkin F5D7230-4 (the router might work if 3rd party firmware is used, such as DD-WRT : http://www.dd-wrt.com/ )

<br>

=REFERENCE LINKS:=

More Information Related to Routers and Solutions @: [http://osgrid.org/forums/viewtopic.php?f=8&t=2283 osgrid.org/forums/viewtopic.php]

=Linux specific solutions=
==SETTING UP A LINUX COMPUTER TO ACT AS A ROUTER==

----

For Linux based Netfilter (iptables) routers, you want to set up the NAT table with some extra entries The following script is something to get you started, you'll need to fix up the variables at the top to match your system and network. <source lang="bash">
#!/bin/bash
#
# vvvvv - Fix these! - vvvvv
IPTABLES=/usr/sbin/iptables
LAN_NETWORK=192.168.0.0/24
SERVER_IP=192.168.0.2
INTERNET_IP=100.100.100.100
REMOTING_PORT=8895
REGION_PORT=9000
# ^^^^^ - Fix these! - ^^^^^

# First, the Destination NAT, anything going to the external address on our ports, we redirect to the server
# Note, if you have a double NAT running and this router doesn't actually have the internet IP address, you'll
# need another set of PREROUTING-DNAT lines with the --destination (-d) set to the internet facing private address
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REMOTING_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p udp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP

# Second, the Source NAT, we need this so that returning packets to our LAN clients go back through the router first,
# otherwise, the server will try to talk directly to the client and the client will reject them
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REMOTING_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p udp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
</source>

--[[User:Hell Fire|Hell Fire]]

==DNS solution==
It's possible to host your own DNS-server, so you can prevent some of the dns-naming problems mentioned before. If http://example.org resolves to the external ip, and that loopback connection is prevented by your router, you could point your resolv.conf to a local nameserver like:
nameserver 192.168.2.2
Now you need bind/named installed in order to handle the dns-requests. You can find a bind example configfile here.

=openWRT Routers:=

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback|OpenWRT NATLoopback]]

=Windows XP Work Around:=

Please see this -> http://vio.blpcomputers.info/loopbacknat.php

NAT Loopback Routers

2010-03-11T18:57:35Z

Thomax:

__NOTOC__

{{Template:Quicklinks}} {{content}} <br>

This page show a list of routers supporting NAT Loopback feature in order to be able to TP in your region when you host it at home on the same computer or local network. Please, feel free to contribute such a list especially if these routers are cheap :D

'''SPECIAL NOTE:'''  Due to the extensive list of routers and capabilities, this is only a basic listing of reported known good routers & modem-router combos and known working devices. 

"D-Link DGL-4xxx series of routers have the largest available nat table of any router on the market.  These routers range from 70$-180$ USD depending on where you live and purchase from."

*D-Link DGL-4500 : http://www.dlink.com/products/?pid=643
*D-Link DGL-4300 : http://www.dlink.com/products/?pid=370
*D-Link DGL-4100 : http://www.dlink.com/products/?pid=371
*D-Link, DIR-635 :  [http://www.dlink.com/products/?pid=DIR-635 http://www.dlink.com/products/?pid=DIR-635]   Easy setup (basically followed instructions for port-forward from the site portforward.com)
*D-Link, DIR-655 : http://www.dlink.com/products/?pid=530<br>

'''Other routers & Hardware'''

*NETGEAR WNR834M : ftp://downloads.netgear.com/files/wnr834m_ref_manual.pdf
*NETGEAR WNR2000 : With firmware 1.2.3.7 ( http://kb.netgear.com/app/answers/detail/a_id/11895 ) loopback now enabled 'out of the box'
*NETGEAR WGR614 : has been confirmed to work out of the box
*Linksys WRT54G & WRT54GS: http://en.wikipedia.org/wiki/Linksys_WRT54G_series
*Arris TM502b : http://portforward.com/english/routers/port_forwarding/Arris/TM502b/
*2wire 2701hg-s NOT Loopback capable. but the 2wire 2701hg-B & 2701hg-D Series ARE loopback capable.  (These can be purchased for approximately $50 USD)
*Thompson SpeedTouch router-modem ST-585i (requires Telnet acces to it to Enable Loopback)
*Thompson Speedtouch ST-780, ST-516
*AVM FritzBox (all Models working perfect) : http://www.avm.de
*Ubee Wireless Cable Router DDW2600  [http://www.ubeeinteractive.com/index.php/products/product-overview/wireless_cable_router1/ http://www.ubeeinteractive.com/index.php/products/product-overview/wireless_cable_router1/]<br>

'''KNOWN non-functional for OpenSim:'''

*Netgear Pro Safe VPN FVS318 : [http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx]
*NetGear WGR614 does not work with ISP required gateway modems)
*Belkin F5D7230-4 (the router might work if 3rd party firmware is used, such as DD-WRT : http://www.dd-wrt.com/ )

<br>

'''REFERENCE LINKS:'''

Thompson Electronics:  [http://www.thomsonbroadbandpartner.com/dsl-modems-gateways/products/index.php http://www.thomsonbroadbandpartner.com/dsl-modems-gateways/products/index.php]

<br>

----

For Linux based Netfilter (iptables) routers, you want to set up the NAT table with some extra entries The following script is something to get you started, you'll need to fix up the variables at the top to match your system and network. <source lang="bash">
#!/bin/bash
#
# vvvvv - Fix these! - vvvvv
IPTABLES=/usr/sbin/iptables
LAN_NETWORK=192.168.0.0/24
SERVER_IP=192.168.0.2
INTERNET_IP=100.100.100.100
REMOTING_PORT=8895
REGION_PORT=9000
# ^^^^^ - Fix these! - ^^^^^

# First, the Destination NAT, anything going to the external address on our ports, we redirect to the server
# Note, if you have a double NAT running and this router doesn't actually have the internet IP address, you'll
# need another set of PREROUTING-DNAT lines with the --destination (-d) set to the internet facing private address
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REMOTING_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p udp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP

# Second, the Source NAT, we need this so that returning packets to our LAN clients go back through the router first,
# otherwise, the server will try to talk directly to the client and the client will reject them
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REMOTING_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p udp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
</source>

--[[User:Hell Fire|Hell Fire]]

'''openWRT Routers:'''

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback|OpenWRT NATLoopback]]

RestConsole

2010-02-28T00:11:11Z

Thomax:

==About==
The REST console makes remote administration of the various OpenSim services possible.

The interface allows sending commands to the server and retrieving command output. Sending and receiving data is done through RESTful HTTP calls.

While sending is very straightforward, receiving is not. Receiving uses reverse HTTP, performing a long poll to a CAPS URI.

In order to make the protocol more efficient, the help functionality has been pushed to the client side. Rather than sending each keystroke to the server, only validated command lines are sent. To make this possible, the server sends a "connect burst" of data, which is the tree of allowed commands and their help information. This can be used by the client to create the "help" command output locally as well as provide command line help interactively.

The sample console client, OpenSim.ConsoleClient.exe, shows how this is done.

==Syntax==
We take the user service(http://foo.bar:8002) as example here. Startup the user service with:
mono OpenSim.Grid.UserServer.exe -console rest

First start a new session by sending a POST.
Params: USER, PASS
http://foo.bar:8002/StartSession/
Return: (XML) <ConsoleSession><SessionID></SessionID><Prompt></Prompt></ConsoleSession>

Now we got the SessionID, which can be used to send a command and to receive output. First, retrieve the console scrollback buffer.
Params: none
http://foo.bar:8002/ReadResponnses/<SessionID>/
Return: (XML) <ConsoleSession><Line Number=x></Line></ConsoleSession>
The reply contains all lines currently in the buffer. Subsequent fetches will only retrieve new lines. The fetch will hold for up to 30 seconds if there is no data, then return an error. The client is expected to try again (polling).

Use the SessionID as ID param, and send a POST again.
Params: ID, COMMAND
http://foo.bar:8002/SessionCommand/
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession>
If everything went well, the command should have been executed. Try another command.

When you want to close down the connection, send a POST again.
PARAMS: ID
http://foo.bar:8002/CloseSession/
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession>
The session is closed, and you have to login again, when you want to send a command again.

==Examples==

In python:

#!/usr/bin/python
# This piece of code is published by thomax (txOh) (c) 2010 under the
# Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)

import urllib, urllib2
import xml.dom.minidom

class UserConsoleClient():

def __init__(self, addr):
self.addr = addr
url = self.addr + 'StartSession/'

params = urllib.urlencode({
'USER': 'Test', # REST username
'PASS': 'secret' # REST password
})
data = urllib2.urlopen(url, params).read()

dom = xml.dom.minidom.parseString(data)
elem = dom.getElementsByTagName('SessionID')
self.sessionid = elem[0].childNodes[0].nodeValue

def close(self):
url = self.addr + 'CloseSession/'
params = urllib.urlencode({
'ID': self.sessionid
})
print urllib2.urlopen(url, params).read()

def do_cmd(self, cmd):
url = self.addr + '/SessionCommand/'
params = urllib.urlencode({
'ID': self.sessionid,
'COMMAND': cmd
})
print urllib2.urlopen(url, params).read()

def read_buffer(self):
url = self.addr + 'ReadResponses/' + self.sessionid + '/'
params = urllib.urlencode({
'ID': self.sessionid
})

print urllib2.urlopen(url, params).read()

# set the base url to the REST console (with port)
console = UserConsoleClient('http://127.0.0.1:8300/')
console.read_buffer()
print 'quit with a "."'
cmd = ""
while cmd != ".":
if cmd != "":
console.do_cmd(cmd)
console.read_buffer()
cmd = raw_input("> ")

console.close()

RestConsole

2010-02-28T00:08:49Z

Thomax:

==About==
The REST console makes remote administration of the various OpenSim services possible.

The interface allows sending commands to the server and retrieving command output. Sending and receiving data is done through RESTful HTTP calls.

While sending is very straightforward, receiving is not. Receiving uses reverse HTTP, performing a long poll to a CAPS URI.

In order to make the protocol more efficient, the help functionality has been pushed to the client side. Rather than sending each keystroke to the server, only validated command lines are sent. To make this possible, the server sends a "connect burst" of data, which is the tree of allowed commands and their help information. This can be used by the client to create the "help" command output locally as well as provide command line help interactively.

The sample console client, OpenSim.ConsoleClient.exe, shows how this is done.

==Syntax==
We take the user service(http://foo.bar:8002) as example here. Startup the user service with:
mono OpenSim.Grid.UserServer.exe -console rest

First start a new session by sending a POST.
Params: USER, PASS
http://foo.bar:8002/StartSession/
Return: (XML) <ConsoleSession><SessionID></SessionID><Prompt></Prompt></ConsoleSession>

Now we got the SessionID, which can be used to send a command and to receive output. First, retrieve the console scrollback buffer.
Params: none
http://foo.bar:8002/ReadResponnses/<SessionID>/
Return: (XML) <ConsoleSession><Line Number=x></Line></ConsoleSession>
The reply contains all lines currently in the buffer. Subsequent fetches will only retrieve new lines. The fetch will hold for up to 30 seconds if there is no data, then return an error. The client is expected to try again (polling).

Use the SessionID as ID param, and send a POST again.
Params: ID, COMMAND
http://foo.bar:8002/SessionCommand/
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession>
If everything went well, the command should have been executed. Try another command.

When you want to close down the connection, send a POST again.
PARAMS: ID
http://foo.bar:8002/CloseSession/
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession>
The session is closed, and you have to login again, when you want to send a command again.

==Examples==

In python:

#!/usr/bin/python
# This piece of code is published by thomax (txOh) (c) 2010 under the
# Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)

import urllib, urllib2
import xml.dom.minidom

class UserConsoleClient():

def __init__(self, addr):
self.addr = addr
url = self.addr + 'StartSession/'

params = urllib.urlencode({
'USER': 'Test',
'PASS': 'secret'
})
data = urllib2.urlopen(url, params).read()

dom = xml.dom.minidom.parseString(data)
elem = dom.getElementsByTagName('SessionID')
self.sessionid = elem[0].childNodes[0].nodeValue

def close(self):
url = self.addr + 'CloseSession/'
params = urllib.urlencode({
'ID': self.sessionid
})
print urllib2.urlopen(url, params).read()

def do_cmd(self, cmd):
url = self.addr + '/SessionCommand/'
params = urllib.urlencode({
'ID': self.sessionid,
'COMMAND': cmd
})
print urllib2.urlopen(url, params).read()

def read_buffer(self):
url = self.addr + 'ReadResponses/' + self.sessionid + '/'
params = urllib.urlencode({
'ID': self.sessionid
})

print urllib2.urlopen(url, params).read()

console = UserConsoleClient('http://127.0.0.1:8300/')
console.read_buffer()
print 'quit with a "."'
cmd = ""
while cmd != ".":
if cmd != "":
console.do_cmd(cmd)
console.read_buffer()
cmd = raw_input("> ")

console.close()

User:Thomax

2009-08-28T18:12:08Z

Thomax:

Use the XML-RPC RemoteAdmin interface with perl: [[Users:Thomax:perl-xmlrpc | Snippet]]

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback | OpenWRT NAT Loopback]]

shortcuts:

* [ http://opensimulator.org/mantis/my_view_page.php mantis ]
* [ http://opensimulator.org/cgi-bin/viewvc.cgi/ browse source ]
* [ http://opensimulator.org/viewgit/?a=summary&p=opensim recent changes ]
* [ http://forge.opensimulator.org/gf/project/ forge projects ]
* [ http://panda.opensimulator.org/ recent builds history ]

User:Thomax

2009-08-25T17:56:42Z

Thomax:

Use the XML-RPC RemoteAdmin interface with perl: [[Users:Thomax:perl-xmlrpc | Snippet]]

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback | OpenWRT NAT Loopback]]

shortcuts:

* [ http://opensimulator.org/mantis/my_view_page.php mantis ]
* [ http://opensimulator.org/cgi-bin/viewvc.cgi/ browse source ]
* [ http://opensimulator.org/viewgit/?a=summary&p=opensim recent changes ]
* [ http://forge.opensimulator.org/gf/project/ forge projects ]

* [ http://panda.opensimulator.org/ recent builds history (dead)]

User:Thomax

2009-08-25T17:56:20Z

Thomax:

Use the XML-RPC RemoteAdmin interface with perl: [[Users:Thomax:perl-xmlrpc | Snippet]]

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback | OpenWRT NAT Loopback]]

shortcuts:

* [ http://opensimulator.org/mantis/my_view_page.php mantis ]
* [ http://opensimulator.org/cgi-bin/viewvc.cgi/ browse source ]
* [ http://opensimulator.org/viewgit/?a=summary&p=opensim recent changes ]
* [ http://forge.opensimulator.org/gf/project/ forge projects ]

* [ http://panda.opensimulator.org/ recent builds history (dead)]

NAT Loopback Routers

2009-07-18T21:29:40Z

Thomax:

__NOTOC__
{{Template:Quicklinks}}
<br />

This page show a list of routers supporting NAT Loopback feature in order to be able to TP in your region when you host it at home on the same computer or local network. Please, feel free to contribute such a list especially if these routers are cheap :D

"D-Link DGL-4xxx series of routers have the largest available nat table of any router on the market"

"These routers range from 70$-180$ USD depending on where you live and purchase from."

* D-Link DGL-4500 : http://games.dlink.com/products/?pid=643
* D-Link DGL-4300 : http://games.dlink.com/products/?pid=370
* D-Link DGL-4100 : http://games.dlink.com/products/?pid=371

Other routers

* Linksys WRT54G : http://en.wikipedia.org/wiki/Linksys_WRT54G_series
* Arris TM502b : http://portforward.com/english/routers/port_forwarding/Arris/TM502b/
* NetGear WGR614 : has been confirmed to work out of the box
(note: NetGear WGR614 does not work with ISP required gateway modems)

Routers that users has experienced problems with

* Belkin F5D7230-4
(the router might work if 3rd party firmware is used, such as DD-WRT : http://www.dd-wrt.com/ )

----

For Linux based Netfilter (iptables) routers, you want to set up the NAT table with some extra entries
The following script is something to get you started, you'll need to fix up the variables at the top to match your system and network.
<source lang=bash>
#!/bin/bash
#
# vvvvv - Fix these! - vvvvv
IPTABLES=/usr/sbin/iptables
LAN_NETWORK=192.168.0.0/24
SERVER_IP=192.168.0.2
INTERNET_IP=100.100.100.100
REMOTING_PORT=8895
REGION_PORT=9000
# ^^^^^ - Fix these! - ^^^^^

# First, the Destination NAT, anything going to the external address on our ports, we redirect to the server
# Note, if you have a double NAT running and this router doesn't actually have the internet IP address, you'll
# need another set of PREROUTING-DNAT lines with the --destination (-d) set to the internet facing private address
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REMOTING_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p udp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP

# Second, the Source NAT, we need this so that returning packets to our LAN clients go back through the router first,
# otherwise, the server will try to talk directly to the client and the client will reject them
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REMOTING_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p udp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
</source>

--[[User:Hell Fire|Hell Fire]]

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback | OpenWRT NAT Loopback]]

User:Thomax:nat-loopback

2009-07-18T21:29:08Z

Thomax:

Well, first is this little script, which should be placed in ''/etc/firewall.user'':

<pre>
# get the WANIP from the ppp0 interface
WANIP=`ifconfig ppp0 | awk '/inet addr/ {split ($2,A,":"); print A[2]}'`

# my lan ip
LANIP = 192.168.1.100

nat_loopback() {
iptables -t nat -A prerouting_rule -d $WANIP -p $3 --dport $1 -j DNAT --to $2
iptables -A forwarding_rule -p $3 --dport $1 -d $2 -j ACCEPT
iptables -t nat -A postrouting_rule -s 192.168.1.0/24 -p $3 --dport $1 -d $2 -j MASQUERADE
}

# thats for a local apache (yepp, i have a local web server..)
nat_loopback 80 $LANIP tcp

# http_listen_port from the OpenSim.ini
nat_loopback 9000 $LANIP tcp

# and the udp port of the region (RegionConfig.ini)
nat_loopback 19010 $LANIP udp
</pre>

And just because I have a dynamic IP address I need to be sure that the firewall rules get reloaded on each new PPPoE connect. Thats why I created the script ''/etc/ppp/ip-up.d/connect.sh''
which looks like this:

<pre>
#!/bin/sh

# Put stuff here you need todo just when your router reconnects to the provider

/etc/init.d/firewall reload
</pre>

Thats what I've additionally done beside the normal LuCI settings on my openWRT router, which is an asus wl-500gP (with this nice two USB slots :-)

Let me know if it helps you too...

thomax

User:Thomax:nat-loopback

2009-07-18T21:28:44Z

Thomax: New page: Well, first is this little script, which should be placed in ''/etc/firewall.user'': <pre> # get the WANIP from the ppp0 interface WANIP=`ifconfig ppp0 | awk '/inet addr/ {split ($2,A,":"...

Well, first is this little script, which should be placed in ''/etc/firewall.user'':

<pre>
# get the WANIP from the ppp0 interface
WANIP=`ifconfig ppp0 | awk '/inet addr/ {split ($2,A,":"); print A[2]}'`

# my lan ip
LANIP = 192.168.1.100

nat_loopback() {
iptables -t nat -A prerouting_rule -d $WANIP -p $3 --dport $1 -j DNAT --to $2
iptables -A forwarding_rule -p $3 --dport $1 -d $2 -j ACCEPT
iptables -t nat -A postrouting_rule -s 192.168.1.0/24 -p $3 --dport $1 -d $2 -j MASQUERADE
}

# thats for a local apache (yepp, i have a local web server..)
nat_loopback 80 $LANIP tcp

# http_listen_port from the OpenSim.ini
nat_loopback 9000 $LANIP tcp

# and the udp port of the region (RegionConfig.ini)
nat_loopback 19010 $LANIP udp
</pre>

Well, and just because I have a dynamic IP address I need to be sure that the firewall rules get reloaded on each new PPPoE connect. Thats why I created the script ''/etc/ppp/ip-up.d/connect.sh''
which looks like this:

<pre>
#!/bin/sh

# Put stuff here you need todo just when your router reconnects to the provider

/etc/init.d/firewall reload
</pre>

Thats what I've additionally done beside the normal LuCI settings on my openWRT router, which is an asus wl-500gP (with this nice two USB slots :-)

Let me know if it helps you too...

thomax

User:Thomax

2009-07-18T20:50:41Z

Thomax:

Use the XML-RPC RemoteAdmin interface with perl: [[Users:Thomax:perl-xmlrpc | Snippet]]

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback | OpenWRT NAT Loopback]]

shortcuts:

* [ http://opensimulator.org/mantis/my_view_page.php mantis ]
* [ http://opensimulator.org/cgi-bin/viewvc.cgi/ browse source ]
* [ http://panda.opensimulator.org/ recent builds history ]
* [ http://forge.opensimulator.org/gf/project/ forge projects ]

User:Thomax

2009-07-18T20:49:14Z

Thomax:

Use the XML-RPC RemoteAdmin interface with perl: [[Users:Thomax:perl-xmlrpc | Snippet]]

If you use openWRT firmware on your router, check here: [[Users:Thomax:perl-xmlrpc | OpenWRT NAT Loopback]]

shortcuts:

* [ http://opensimulator.org/mantis/my_view_page.php mantis ]
* [ http://opensimulator.org/cgi-bin/viewvc.cgi/ browse source ]
* [ http://panda.opensimulator.org/ recent builds history ]
* [ http://forge.opensimulator.org/gf/project/ forge projects ]

HyperGrid Team

2009-06-21T16:50:52Z

Thomax: /* Collaboration Sites */

__NOTOC__
{{Template:Quicklinks}}
<br />

== What is the <nowiki>HyperGrid</nowiki> Team? ==
The <nowiki>HyperGrid Team</nowiki> are a pioneering group of [[Gridnaut|Gridnauts]] dedicated to establishing a network of [[HyperGrid_Regions|HyperGrid Regions]] spanning every Grid possible. Our collective goal is to create a true [[HyperGrid]] across the [[Metaverse|Metaverse]].

== Who is the HyperGrid Team? ==
The HyperGrid Team is made up of people who are excited about the endless possibilities of being able to TelePort from Grid to Grid at the click of a prim. The majority of the team are themselves owners of HyperGrid Regions.

=== Core Hypergrid Team ===

* Andreas mueller (Graphics/Web Designer)
* Bruce Patton (Builder/Scripter)
* Diva (Opensimulator HG Developer)
* eaglefx Binder (Tech/Builder/Wiki)
* GoldenHawk (Builder/Scripter)
* [[User:Mikebert |Mikebert M34]] (Wiki,Builder,Scripter,Networking Pro)
* Richardus Raymaker
* Tiffany Sicling (Builder)
* Warin Cascabel (Builder/Scripter)

=== Testers on Hypergrid Team ===
* Andreas mueller
* Bruce Patton
* eaglefx Binder
* Jos Joszpe
* Richardus Raymaker
* Tiffany Sicling
* Carlos Roundel (owner Cyberlandia hypergrided Grid)
* Snoopy Pfeffer
* Your Name Here

== What are you doing? ==

=== Main ToDo List ===
* [[HyperGrid_Team/ToDo|HyperGrid Team Todo List]]
* [[HyperGrid_Team/HowTo|HyperGrid Install and Running]]

=== Current Projects ===
* [[HyperGrid_Team/Current_Projects/HyperGrid_Stargate|HyperGrid Stargate]]

=== Proposed Projects ===
* [[HyperGrid_Team/Proposed_Projects/HG_Stargate_Vendor|HG Stargate Vendor]]
* [[HyperGrid_Team/Proposed_Projects/HG_Health_Monitor|HG Health Monitor]]
* [[HyperGrid_Team/Proposed_Projects/Metaverse_Connection_Centers|Metaverse Connection Centers]]

== Press ==

[http://www.mariasworlds.com/2009/04/internet-history-made-today-travels-thorugh-the-stargate/ Travels through the Stargate from Marias World]

[http://www.mogulus.com/metaworld2/ondemand/pla_3610768549260411462?initthumburl=http://mogulus-user-files.s3.amazonaws.com/chv2metaworld2/2009/05/13/16a8a882-c83c-4d5b-9cb1-4458ee8682e5_1440.jpg&playeraspectwidth=4&playeraspectheight=3 Diva's session in SecondLife "The Hypergrid: An Architecture for a New Web]

== Are you on IRC? ==
Yes, we are. You can find us on irc.freenode.net #hypergrid

== When/Where are the meetings? ==
The Team meets once a week on Wednesday at 21:00 (9 PM) UTC/GMT (http://wwp.greenwichmeantime.com/) or 12:00 PST Viewer time.

=== Upcoming Meetings ===

{| cellpadding="10"
!Date
!Agenda
!Location
!SLURL
!Team Member
!ToDo
!Chat Logs
|-
|June 3, 2009
|[[HyperGrid_Team/Agenda/2009.0306|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.0306|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.0306|Chat Logs]]
|-
|}

=== Previous Meetings ===

{| cellpadding="10"
!Date
!Agenda
!Location
!SLURL
!Team Member
!Todo
!Chat Logs
|-
|May 27, 2009
|[[HyperGrid_Team/Agenda/2009.2705|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.2705|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.2705|Chat Logs]]
|-
|-
|May 20, 2009
|[[HyperGrid_Team/Agenda/2009.2005|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.2005|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.2005|Chat Logs]]
| chat log pending
|-
|-
|May 13, 2009
|[[HyperGrid_Team/Agenda/2009.1305|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.1305|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.1305|Chat Logs]]
|-
|-
|May 6, 2009
|[[HyperGrid_Team/Agenda/2009.0506|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.0506|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.0506|Chat Logs]]
|This meeting was cancelled
|-
|-
|April 29, 2009
|[[HyperGrid_Team/Agenda/2009.0429|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.0429|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.0429|Chat Logs]]
|-
|-
|April 22, 2009
|[[HyperGrid_Team/Agenda/2009.0422|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.0422|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.0422|Chat Logs]]
|-
|-
|April 15, 2009
|[[HyperGrid_Team/Agenda/2009.0415|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
||[[HyperGrid_Team/ToDo/2009.0415|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.0415|Chat Logs]]
|-
|April 8, 2009
|[[HyperGrid_Team/Agenda/2009.0408|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.0408|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.0408|Chat Logs]]
|-
|April 1, 2009
|Agenda
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.0401|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.0402|Chat Logs]]
|-
|March 25, 2009
|Agenda
|Wright Plaza
|
|
|
|[[HyperGrid_Team/Chat_Logs/2009.0325|Chat Logs]]
|}

== HyperGrid Team Related Web Resources ==

=== Collaboration Sites ===

* http://www.hypergrids.org - Just new released
* http://www.opensim.de/doku.php?id=projekte:hypergrid - German Wiki
* http://www.gridhop.net/ - a web based hypergrid portal aimed to work with the built-in browser. It also offer a open data export, actually XML only, under http://www.gridhop.net/cgi/gridhopexport

== Some HyperGrid Regions on the Team ==

=== Standalone HyperGrid Regions ===
{| cellpadding="10"
| Richardus's Hyper
| secondlife://osg.rigutech.nl:9000/
| coords, x=11109,y=11111
|-
| Sunred Hyper
| secondlife://hypergrid.sunredbeach.com:9000/
| coords, x=11111, y=11111
|-
| Hypervz
| secondlife://hypervz.hypergrid.dk:9000/
| coords, x=8100, y=8100
|-
| Metaverse Sims
| secondlife://metaversesims.net:9000/
| coords, x=9000, y=9000
|
|-
| OpenSIM.de / M34 Sim-1
| secondlife://opensim.mydyn.de:9090/
| coords, x=4400, y=4400
|
|-
| OpenSIM.de / M34 Sim-2
| secondlife://grid.mydyn.de:9190/
| coords, x=7000, y=7000
|
|-
| OpenSIM.de / M34 Sim-3
| secondlife://hypergrid.mydyn.de:9290/
| coords, x=11000, y=11000
|
|-
| Cyberlandia.net
| secondlife://grid.cyberlandia.net:9000/
| coords, x=1002, y=1000
|
|}
=== OSGrid HyperGrid Regions ===
{| cellpadding="10"
| Wright Plaza
| secondlife://plaza02.osgrid.org:9101/
| coords, x=10000, y=10000
|-
| Lbsa Plaza
| secondlife://plaza02.osgrid.org:9102/
| coords, x=9995, y=9995
|-
| Sandbox Plaza
| secondlife://plaza02.osgrid.org:9303/
| coords, x=10128, y=10126
|-
| Samsara
| secondlife://66.240.232.94:9010/
| coords, x=10006, y=9999
|-
| Snoopies
| secondlife://66.240.232.94:9011/
| coords, x=10005, y=9999
|-
| Nibiru
| secondlife://vimana.dyndns.org:9000/
| coords, x=8000, y=8000
|-
| Sunred Gateway
| secondlife://217.157.61.105:9000:Sunred Gateway/
| coords, x=9995, y=10006
|-
| UCI Welcome
| secondlife://osl2.nac.uci.edu:9006/
| coords, x=10000, y=10000
|}

=== MyOpenGrid HyperGrid Regions ===

{| cellpadding="10"
| Over Land
| secondlife://myopengrid.com:9005/
| coords, x=7001, y=7001
|
|
|}

=== Public Hypergrid Nodes ===

{| cellpadding="10"
| http://opensimulator.org/wiki/Public_Hypergrid_Nodes
|-
|}

{{Languages}}

[[Category:Help|Formatting]]

HyperGrid Team

2009-06-21T16:44:14Z

Thomax: /* Collaboration Sites */

__NOTOC__
{{Template:Quicklinks}}
<br />

== What is the <nowiki>HyperGrid</nowiki> Team? ==
The <nowiki>HyperGrid Team</nowiki> are a pioneering group of [[Gridnaut|Gridnauts]] dedicated to establishing a network of [[HyperGrid_Regions|HyperGrid Regions]] spanning every Grid possible. Our collective goal is to create a true [[HyperGrid]] across the [[Metaverse|Metaverse]].

== Who is the HyperGrid Team? ==
The HyperGrid Team is made up of people who are excited about the endless possibilities of being able to TelePort from Grid to Grid at the click of a prim. The majority of the team are themselves owners of HyperGrid Regions.

=== Core Hypergrid Team ===

* Andreas mueller (Graphics/Web Designer)
* Bruce Patton (Builder/Scripter)
* Diva (Opensimulator HG Developer)
* eaglefx Binder (Tech/Builder/Wiki)
* GoldenHawk (Builder/Scripter)
* [[User:Mikebert |Mikebert M34]] (Wiki,Builder,Scripter,Networking Pro)
* Richardus Raymaker
* Tiffany Sicling (Builder)
* Warin Cascabel (Builder/Scripter)

=== Testers on Hypergrid Team ===
* Andreas mueller
* Bruce Patton
* eaglefx Binder
* Jos Joszpe
* Richardus Raymaker
* Tiffany Sicling
* Carlos Roundel (owner Cyberlandia hypergrided Grid)
* Snoopy Pfeffer
* Your Name Here

== What are you doing? ==

=== Main ToDo List ===
* [[HyperGrid_Team/ToDo|HyperGrid Team Todo List]]
* [[HyperGrid_Team/HowTo|HyperGrid Install and Running]]

=== Current Projects ===
* [[HyperGrid_Team/Current_Projects/HyperGrid_Stargate|HyperGrid Stargate]]

=== Proposed Projects ===
* [[HyperGrid_Team/Proposed_Projects/HG_Stargate_Vendor|HG Stargate Vendor]]
* [[HyperGrid_Team/Proposed_Projects/HG_Health_Monitor|HG Health Monitor]]
* [[HyperGrid_Team/Proposed_Projects/Metaverse_Connection_Centers|Metaverse Connection Centers]]

== Press ==

[http://www.mariasworlds.com/2009/04/internet-history-made-today-travels-thorugh-the-stargate/ Travels through the Stargate from Marias World]

[http://www.mogulus.com/metaworld2/ondemand/pla_3610768549260411462?initthumburl=http://mogulus-user-files.s3.amazonaws.com/chv2metaworld2/2009/05/13/16a8a882-c83c-4d5b-9cb1-4458ee8682e5_1440.jpg&playeraspectwidth=4&playeraspectheight=3 Diva's session in SecondLife "The Hypergrid: An Architecture for a New Web]

== Are you on IRC? ==
Yes, we are. You can find us on irc.freenode.net #hypergrid

== When/Where are the meetings? ==
The Team meets once a week on Wednesday at 21:00 (9 PM) UTC/GMT (http://wwp.greenwichmeantime.com/) or 12:00 PST Viewer time.

=== Upcoming Meetings ===

{| cellpadding="10"
!Date
!Agenda
!Location
!SLURL
!Team Member
!ToDo
!Chat Logs
|-
|June 3, 2009
|[[HyperGrid_Team/Agenda/2009.0306|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.0306|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.0306|Chat Logs]]
|-
|}

=== Previous Meetings ===

{| cellpadding="10"
!Date
!Agenda
!Location
!SLURL
!Team Member
!Todo
!Chat Logs
|-
|May 27, 2009
|[[HyperGrid_Team/Agenda/2009.2705|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.2705|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.2705|Chat Logs]]
|-
|-
|May 20, 2009
|[[HyperGrid_Team/Agenda/2009.2005|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.2005|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.2005|Chat Logs]]
| chat log pending
|-
|-
|May 13, 2009
|[[HyperGrid_Team/Agenda/2009.1305|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.1305|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.1305|Chat Logs]]
|-
|-
|May 6, 2009
|[[HyperGrid_Team/Agenda/2009.0506|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.0506|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.0506|Chat Logs]]
|This meeting was cancelled
|-
|-
|April 29, 2009
|[[HyperGrid_Team/Agenda/2009.0429|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.0429|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.0429|Chat Logs]]
|-
|-
|April 22, 2009
|[[HyperGrid_Team/Agenda/2009.0422|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.0422|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.0422|Chat Logs]]
|-
|-
|April 15, 2009
|[[HyperGrid_Team/Agenda/2009.0415|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
||[[HyperGrid_Team/ToDo/2009.0415|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.0415|Chat Logs]]
|-
|April 8, 2009
|[[HyperGrid_Team/Agenda/2009.0408|Agenda]]
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.0408|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.0408|Chat Logs]]
|-
|April 1, 2009
|Agenda
|Nibiru OSGrid
|secondlife://vimana.dyndns.org:9000/
|Tiffany Sicling
|[[HyperGrid_Team/ToDo/2009.0401|Todo]]
|[[HyperGrid_Team/Chat_Logs/2009.0402|Chat Logs]]
|-
|March 25, 2009
|Agenda
|Wright Plaza
|
|
|
|[[HyperGrid_Team/Chat_Logs/2009.0325|Chat Logs]]
|}

== HyperGrid Team Related Web Resources ==

=== Collaboration Sites ===

* http://www.hypergrids.org - Just new released
* http://www.opensim.de/doku.php?id=projekte:hypergrid - German Wiki
* http://www.gridhop.net/ - a web based hypergrid portal aimed to work with the built-in browser

== Some HyperGrid Regions on the Team ==

=== Standalone HyperGrid Regions ===
{| cellpadding="10"
| Richardus's Hyper
| secondlife://osg.rigutech.nl:9000/
| coords, x=11109,y=11111
|-
| Sunred Hyper
| secondlife://hypergrid.sunredbeach.com:9000/
| coords, x=11111, y=11111
|-
| Hypervz
| secondlife://hypervz.hypergrid.dk:9000/
| coords, x=8100, y=8100
|-
| Metaverse Sims
| secondlife://metaversesims.net:9000/
| coords, x=9000, y=9000
|
|-
| OpenSIM.de / M34 Sim-1
| secondlife://opensim.mydyn.de:9090/
| coords, x=4400, y=4400
|
|-
| OpenSIM.de / M34 Sim-2
| secondlife://grid.mydyn.de:9190/
| coords, x=7000, y=7000
|
|-
| OpenSIM.de / M34 Sim-3
| secondlife://hypergrid.mydyn.de:9290/
| coords, x=11000, y=11000
|
|-
| Cyberlandia.net
| secondlife://grid.cyberlandia.net:9000/
| coords, x=1002, y=1000
|
|}
=== OSGrid HyperGrid Regions ===
{| cellpadding="10"
| Wright Plaza
| secondlife://plaza02.osgrid.org:9101/
| coords, x=10000, y=10000
|-
| Lbsa Plaza
| secondlife://plaza02.osgrid.org:9102/
| coords, x=9995, y=9995
|-
| Sandbox Plaza
| secondlife://plaza02.osgrid.org:9303/
| coords, x=10128, y=10126
|-
| Samsara
| secondlife://66.240.232.94:9010/
| coords, x=10006, y=9999
|-
| Snoopies
| secondlife://66.240.232.94:9011/
| coords, x=10005, y=9999
|-
| Nibiru
| secondlife://vimana.dyndns.org:9000/
| coords, x=8000, y=8000
|-
| Sunred Gateway
| secondlife://217.157.61.105:9000:Sunred Gateway/
| coords, x=9995, y=10006
|-
| UCI Welcome
| secondlife://osl2.nac.uci.edu:9006/
| coords, x=10000, y=10000
|}

=== MyOpenGrid HyperGrid Regions ===

{| cellpadding="10"
| Over Land
| secondlife://myopengrid.com:9005/
| coords, x=7001, y=7001
|
|
|}

=== Public Hypergrid Nodes ===

{| cellpadding="10"
| http://opensimulator.org/wiki/Public_Hypergrid_Nodes
|-
|}

{{Languages}}

[[Category:Help|Formatting]]

Known Web Interfaces within OpenSim

2009-05-08T20:01:59Z

Thomax: /* RegionPlugin */

= OpenMetaverse =
CAPS Requested
"ChatSessionRequest"
"CopyInventoryFromNotecard"
"DispatchRegionInfo"
"EstateChangeInfo"
"EventQueueGet"
"FetchInventory"
"WebFetchInventoryDescendents"
"FetchLib"
"FetchLibDescendents"
"GroupProposalBallot"
"HomeLocation"
"MapLayer"
"MapLayerGod"
"NewFileAgentInventory"
"ParcelPropertiesUpdate"
"ParcelVoiceInfoRequest"
"ProvisionVoiceAccountRequest"
"RemoteParcelRequest"
"RequestTextureDownload"
"SearchStatRequest"
"SearchStatTracking"
"SendPostcard"
"SendUserReport"
"SendUserReportWithScreenshot"
"ServerReleaseNotes"
"StartGroupProposal"
"UntrustedSimulatorMessage"
"UpdateAgentInformation"
"UpdateAgentLanguage"
"UpdateGestureAgentInventory"
"UpdateNotecardAgentInventory"
"UpdateScriptAgent"
"UpdateGestureTaskInventory"
"UpdateNotecardTaskInventory"
"UpdateScriptTask"
"UploadBakedTexture"
"ViewerStartAuction"
"ViewerStats"

= OpenSim =
== ApplicationPlugin ==
=== Rest ===
==== RegionPlugin ====
REST
POST "/admin/regions/"
GET "/admin/regions/"
GET "/admin/regions/<region-UUID>"
GET "/admin/regioninfo/"

==== InventoryServices ====
REST
GET "/admin/inventory/firstname lastname"

==== AppearanceServices ====
REST
==== AssetServices ====
REST

== Framework ==
=== Communications ===
CAPS
"SEED" "CAPS/0000/"
"MapLayer" "CAPS/0001/"
"NewFileAgentInventory" "CAPS/0002/"
"RequestTextureDownload" "CAPS/0003/"
"UpdateNotecardAgentInventory" "CAPS/0004/"
"UpdateScriptAgentInventory" "CAPS/0004/"
"UpdateScriptAgent" "CAPS/0004/"
"UpdateScriptTaskInventory" "CAPS/0005/"
"UpdateScriptTask" "CAPS/0005/"
"FetchInventoryDescendents" "CAPS/0006/"

== Region ==
=== Communications ===
==== OGS1 ====
XMLRPC
"check"
"land_data"
==== Hypergrid ====
XMLRPC
"logoff_user"
"check"
"land_data"
"link_region"
"expect_hg_user"
=== CoreModules ===
==== World ====
LLSD
"/MAP/MapItems/<RegionID>"
==== InterGrid ====
LLSD
"/agent" # agent domain message
"/" # region domain seed
"/<RegionName>" # region domain seed
==== Avatar ====
REST
POST "CAPS/OA/<ID>" # ObjectAdd
XMLRPC
"presence_update_bulk"
"terminate_friend"
"balanceUpdateRequest"
"userAlert"
"getCurrencyQuote"
"buyCurrency"
"preflightBuyLandPrep"
"buyLandPrep"
==== Scripting ====
XMLRPC
"llRemoteData"
==== Framework ====
XMLRPC
"simulator_data_request"
"map_block"
"search_for_region_by_name"
==== Hypergrid ====
XMLRPC
"hg_login"
"hg_new_auth_key"
"hg_verify_auth_key"
"check_auth_session"

== Grid ==
=== InventoryServer ===
REST
POST "GetInventory/"
POST "UpdateFolder/"
POST "MoveFolder/"
POST "PurgeFolder/"
POST "DeleteItem/"
POST "QueryItem/"
POST "QueryFolder/"
POST "CreateInventory/"
POST "NewFolder/"
POST "NewItem/"
POST "AddNewItem/"
POST "GetItems/"
POST "ActiveGestures/"
POST "RootFolders/"
=== UserServer.Modules ===
REST
GET "/users/"
DELETE "/usersessions/"
GET "/get_grid_info"
XMLRPC
"get_grid_info"
"add_new_user_friend"
"remove_user_friend"
"update_user_friend_perms"
"get_user_friend_list"
"hg_login"
"hg_new_auth_key"
"hg_verify_auth_key"
"get_user_by_name"
"get_user_by_uuid"
"get_avatar_picker_avatar"
"update_user_current_region"
"logout_of_simulator"
"get_agent_by_uuid"
"update_user_profile"
"get_avatar_appearance"
"update_avatar_appearance"
"login_to_simulator"
"set_login_params"
"check_auth_session"
=== GridServier.Modules ===
Rest
REST
GET "sims/"
POST "sims/"
GET "regions/"
POST "regions/"
User
XMLRPC
"simulator_login"
"simulator_data_request"
"simulator_after_region_moved"
"map_block"
"search_for_region_by_name"
"register_messageserver"
"deregister_messageserver"

== Client ==
=== Linden ===
XMLRPC
"expect_user"
"logoff_user"
"login_to_simulator"

Known Web Interfaces within OpenSim

2009-05-08T19:59:54Z

Thomax: /* InventoryServices */

= OpenMetaverse =
CAPS Requested
"ChatSessionRequest"
"CopyInventoryFromNotecard"
"DispatchRegionInfo"
"EstateChangeInfo"
"EventQueueGet"
"FetchInventory"
"WebFetchInventoryDescendents"
"FetchLib"
"FetchLibDescendents"
"GroupProposalBallot"
"HomeLocation"
"MapLayer"
"MapLayerGod"
"NewFileAgentInventory"
"ParcelPropertiesUpdate"
"ParcelVoiceInfoRequest"
"ProvisionVoiceAccountRequest"
"RemoteParcelRequest"
"RequestTextureDownload"
"SearchStatRequest"
"SearchStatTracking"
"SendPostcard"
"SendUserReport"
"SendUserReportWithScreenshot"
"ServerReleaseNotes"
"StartGroupProposal"
"UntrustedSimulatorMessage"
"UpdateAgentInformation"
"UpdateAgentLanguage"
"UpdateGestureAgentInventory"
"UpdateNotecardAgentInventory"
"UpdateScriptAgent"
"UpdateGestureTaskInventory"
"UpdateNotecardTaskInventory"
"UpdateScriptTask"
"UploadBakedTexture"
"ViewerStartAuction"
"ViewerStats"

= OpenSim =
== ApplicationPlugin ==
=== Rest ===
==== RegionPlugin ====
REST
POST "regions/"
GET "regions/"
GET "regionsinfo/"
==== InventoryServices ====
REST
GET "/admin/inventory/firstname lastname"

==== AppearanceServices ====
REST
==== AssetServices ====
REST

== Framework ==
=== Communications ===
CAPS
"SEED" "CAPS/0000/"
"MapLayer" "CAPS/0001/"
"NewFileAgentInventory" "CAPS/0002/"
"RequestTextureDownload" "CAPS/0003/"
"UpdateNotecardAgentInventory" "CAPS/0004/"
"UpdateScriptAgentInventory" "CAPS/0004/"
"UpdateScriptAgent" "CAPS/0004/"
"UpdateScriptTaskInventory" "CAPS/0005/"
"UpdateScriptTask" "CAPS/0005/"
"FetchInventoryDescendents" "CAPS/0006/"

== Region ==
=== Communications ===
==== OGS1 ====
XMLRPC
"check"
"land_data"
==== Hypergrid ====
XMLRPC
"logoff_user"
"check"
"land_data"
"link_region"
"expect_hg_user"
=== CoreModules ===
==== World ====
LLSD
"/MAP/MapItems/<RegionID>"
==== InterGrid ====
LLSD
"/agent" # agent domain message
"/" # region domain seed
"/<RegionName>" # region domain seed
==== Avatar ====
REST
POST "CAPS/OA/<ID>" # ObjectAdd
XMLRPC
"presence_update_bulk"
"terminate_friend"
"balanceUpdateRequest"
"userAlert"
"getCurrencyQuote"
"buyCurrency"
"preflightBuyLandPrep"
"buyLandPrep"
==== Scripting ====
XMLRPC
"llRemoteData"
==== Framework ====
XMLRPC
"simulator_data_request"
"map_block"
"search_for_region_by_name"
==== Hypergrid ====
XMLRPC
"hg_login"
"hg_new_auth_key"
"hg_verify_auth_key"
"check_auth_session"

== Grid ==
=== InventoryServer ===
REST
POST "GetInventory/"
POST "UpdateFolder/"
POST "MoveFolder/"
POST "PurgeFolder/"
POST "DeleteItem/"
POST "QueryItem/"
POST "QueryFolder/"
POST "CreateInventory/"
POST "NewFolder/"
POST "NewItem/"
POST "AddNewItem/"
POST "GetItems/"
POST "ActiveGestures/"
POST "RootFolders/"
=== UserServer.Modules ===
REST
GET "/users/"
DELETE "/usersessions/"
GET "/get_grid_info"
XMLRPC
"get_grid_info"
"add_new_user_friend"
"remove_user_friend"
"update_user_friend_perms"
"get_user_friend_list"
"hg_login"
"hg_new_auth_key"
"hg_verify_auth_key"
"get_user_by_name"
"get_user_by_uuid"
"get_avatar_picker_avatar"
"update_user_current_region"
"logout_of_simulator"
"get_agent_by_uuid"
"update_user_profile"
"get_avatar_appearance"
"update_avatar_appearance"
"login_to_simulator"
"set_login_params"
"check_auth_session"
=== GridServier.Modules ===
Rest
REST
GET "sims/"
POST "sims/"
GET "regions/"
POST "regions/"
User
XMLRPC
"simulator_login"
"simulator_data_request"
"simulator_after_region_moved"
"map_block"
"search_for_region_by_name"
"register_messageserver"
"deregister_messageserver"

== Client ==
=== Linden ===
XMLRPC
"expect_user"
"logoff_user"
"login_to_simulator"

User:Thomax

2009-05-08T14:39:15Z

Thomax: Undo revision 12115 by Thomax (Talk)

Use the XML-RPC RemoteAdmin interface with perl: [[Users:Thomax:perl-xmlrpc | Snippet]]

shortcuts:

* [ http://opensimulator.org/mantis/my_view_page.php mantis ]
* [ http://opensimulator.org/cgi-bin/viewvc.cgi/ browse source ]
* [ http://panda.opensimulator.org/ recent builds history ]
* [ http://forge.opensimulator.org/gf/project/ forge projects ]

User:Thomax

2009-05-08T14:35:59Z

Thomax:

Use the XML-RPC RemoteAdmin interface with perl: [[Users:Thomax:perl-xmlrpc | Snippet]]

shortcuts:

* [[ mantis | http://opensimulator.org/mantis/my_view_page.php ]]
* [[ browse source | http://opensimulator.org/cgi-bin/viewvc.cgi/ ]]
* [[ recent builds history | http://panda.opensimulator.org/ ]]
* [[ forge projects | http://forge.opensimulator.org/gf/project/ ]]

User:Thomax

2009-05-08T10:28:00Z

Thomax:

Use the XML-RPC RemoteAdmin interface with perl: [[Users:Thomax:perl-xmlrpc | Snippet]]

shortcuts:

* [[ http://opensimulator.org/mantis/my_view_page.php | mantis ]]
* [[ http://opensimulator.org/cgi-bin/viewvc.cgi/ | browse source ]]
* [[ http://panda.opensimulator.org/ | recent builds history ]]
* [[ http://forge.opensimulator.org/gf/project/ | forge projects ]]

User:Thomax

2009-05-08T10:25:21Z

Thomax:

User:Thomax

2009-05-08T10:24:36Z

Thomax:

Use the XML-RPC RemoteAdmin interface with perl: [[Users:Thomax:perl-xmlrpc | Snippet]]

shortcuts:

* [[ http://opensimulator.org/cgi-bin/viewvc.cgi/ | browse source ]]
* [[ http://panda.opensimulator.org/ | recent builds history ]]

User:Thomax

2009-05-08T10:23:23Z

Thomax:

Use the XML-RPC RemoteAdmin interface with perl: [[Users:Thomax:perl-xmlrpc | Snippet]]

shortcuts:

[[ http://opensimulator.org/cgi-bin/viewvc.cgi/ | browse source ]]
[[ http://panda.opensimulator.org/ || recent builds history ]]

OSSL

2009-05-04T16:50:29Z

Thomax:

This is currently written up in one of justincc's [http://justincc.wordpress.com/2008/10/24/opensim-scripting-languages-lsl-and-ossl blog posts]. Some of that information should be transferred to here

Read whats [[ OSSL_Implemented | implemented ]].

RemoteAdmin

2009-05-03T12:03:52Z

Thomax:

<div style="background-color:#ffa0a0; padding:15px">
<b>Caution ! The RemoteAdmin feature is unsecured at this time. For testing uses only.</b>
</div>

== How to Setup the Remote Admin ==

=== Setup OpenSim ===

First you should enable the remote admin interface to do so just add the following lines to your OpenSim.ini file:

[RemoteAdmin]
enabled = true
access_password = secret

=== Example in Python ===
# Author : DrScofield
# Source : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/
# License : BSD License

#!/usr/bin/python
import xmlrpclib

# XML-RPC URL (http_listener_port)
gridServerURL = ‘http://127.0.0.1:9000′

# instantiate server object
gridServer = xmlrpclib.Server(gridServerURL)

# invoke admin_alert: requires password and message
gridServer.admin_broadcast({’password’: ’secret’, ‘message’: ‘the answer is 42′})

=== RemoteAdmin executable for Windows ===

The RemoteAdmin executable for Windows is a command line tool based on the RemoteAdmin PHP Class.

Downloads and documentation on the [http://lab.newworldgrid.com/index.php/RemoteAdmin_Executable RemoteAdmin Executable webpage]

=== Example in PHP ===

This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here].
<source lang=php>
<?php

// Author : Olish Newman
// Source : http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass
// Licence : BSD License

// Including the RemoteAdmin PHP class. It can be downloaded from the link above.
include('RemoteAdmin.php');

// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret');

// Invoke admin_broadcast
$parameters = array('message' => 'the answer is 42');
$myRemoteAdmin->SendCommand('admin_broadcast', $parameters);

// Invoke admin_shutdown (example for use without parameters)
$myRemoteAdmin->SendCommand('admin_shutdown');

// Invoke admin_create_user (multiple parameters)
$parameters = array('user_firstname' => 'Ruth', 'user_lastname' => 'OpenSim', 'user_password' => 'MyPassword', 'start_region_x' => '1000', 'start_region_y' => '1000');
$myRemoteAdmin->SendCommand('admin_create_user', $parameters);
?>
</source>

Note: This script does not appear to work for create user because it tries to pass the start region x and y as a string when the RemoteAdmin needs a string. The class needs to be edited to pass it as a number or edit the remoteadmin source to convert the string to a unsigned int.

Another example in PHP5, using CURL.
<source lang="php">
//This is the slightly modified RPC-class of the BSD-licensed WiXTD webportal
<?php
class RemotePC {

function __construct() {
$this->serveruri = "http://myhost";
$this->serverport ="9000";
$this->password ="foobar";
}

function call($command,$parameters) {
$parameters['password'] = $this->password;
$request = xmlrpc_encode_request($command, $parameters);
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $this->serveruri);
curl_setopt( $ch, CURLOPT_PORT, $this->serverport]);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ( $ch, CURLOPT_POSTFIELDS, $request);
curl_setopt ( $ch, CURLOPT_TIMEOUT, 5);
$result = curl_exec($ch);
curl_close($ch);
return xmlrpc_decode($result);
}
}
?>
</source>

=== Example in Perl ===

Because the OpenSim internal web server just accepts HTTP/1.0 requests, it's worth to give a perl example. It's not a daily thing to do HTTP/1.0 within the LWP environment. You can get the '''[[Users:Thomax:perl-xmlrpc | Perl example here]]'''.

== RemoteAdmin Commands ==
<table border="1" cellspacing="0" cellpadding="4">
<tr>
<th>Name</th>
<th>Status</th>
<th>Description</th>
<th>Parameters</th>
</tr>
<tr>
<td>[[remoteadmin:admin_create_region | admin_create_region]]</td>
<td></td>
<td>Create a new region</td>
<td>region_name, region_master_first,
region_master_last, region_master_password, listen_ip, external_address</td>
</tr>
<tr>
<td>[[remoteadmin:admin_delete_region | admin_delete_region]]</td>
<td></td>
<td>Delete a region</td>
<td>region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_shutdown | admin_shutdown]]</td>
<td></td>
<td>Shut down the simulator</td>
<td>''No parameter needed''</td>
</tr>
<tr>
<td>[[remoteadmin:admin_broadcast| admin_broadcast]]</td>
<td></td>
<td>Send a general alert</td>
<td>message</td>
</tr>
<tr>
<td>[[remoteadmin:admin_restart| admin_restart]]</td>
<td></td>
<td>Restart Region</td>
<td>regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_heightmap| admin_load_heightmap]]</td>
<td></td>
<td>Load Height Map</td>
<td>filename, regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user| admin_create_user]]</td>
<td></td>
<td>Create a new user</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_exists_user| admin_exists_user]]</td>
<td></td>
<td>Check whether a certain user account exists</td>
<td>user_firstname, user_lastname</td>
</tr>
<tr>
<td>[[remoteadmin:admin_update_user| admin_update_user]]</td>
<td></td>
<td>Update the password/home of a user account</td>
<td>user_firstname user_lastname user_password start_region_x start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_xml| admin_load_xml]]</td>
<td></td>
<td>Execute the Load XML command</td>
<td>filename region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_xml| admin_save_xml]]</td>
<td></td>
<td>Execute the Save XML command</td>
<td>filename region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_oar| admin_load_oar]]</td>
<td></td>
<td>Load a saved OAR file into a region</td>
<td>filename region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
</table>

== Credits ==
Thanks to DrScofield for the Python Script
Sources : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/

[[Category:Development]]

User:Thomax:perl-xmlrpc

2009-05-03T11:53:52Z

Thomax:

<pre>
#!/usr/bin/perl

BEGIN {
# because the opensim http server just accept old HTTP/1.0 protocol!!!
$ENV{PERL_LWP_USE_HTTP_10} ||= 1; # default to http/1.0
}

use RPC::XML::Client;

my $client = new RPC::XML::Client('http://localhost:9000');
my $req = RPC::XML::request->new(
'admin_broadcast',
{
password => 'secret',
message => '2 + 3 = 23'
}
);

my $res = $client->send_request($req);
my %val = %$res;
my $key;

foreach $key (keys %val) {
print "$key --> ". $val{$key}->as_string ."\n";
}
</pre>

User:Thomax:perl-xmlrpc

2009-05-03T11:51:39Z

Thomax: New page: <code> #!/usr/bin/perl BEGIN { # because the opensim http server just accept old HTTP/1.0 protocol!!! $ENV{PERL_LWP_USE_HTTP_10} ||= 1; # default to http/1.0 } use RPC::XML::Cli...

<code>
#!/usr/bin/perl

BEGIN {
# because the opensim http server just accept old HTTP/1.0 protocol!!!
$ENV{PERL_LWP_USE_HTTP_10} ||= 1; # default to http/1.0
}

use RPC::XML::Client;

my $client = new RPC::XML::Client('http://localhost:9000');
my $req = RPC::XML::request->new(
'admin_broadcast',
{
password => 'secret',
message => '2 + 3 = 23'
}
);

my $res = $client->send_request($req);
my %val = %$res;
my $key;

foreach $key (keys %val) {
print "$key --> ". $val{$key}->as_string ."\n";
}
</code>

User:Thomax

2009-05-03T11:46:35Z

Thomax:

Use the XML-RPC RemoteAdmin interface with perl: [[Users:Thomax:perl-xmlrpc | Snippet]]

User:Thomax

2009-05-03T11:45:16Z

Thomax: New page: Use the XML-RPC RemoteAdmin interface with perl: Users:Thomax:perl-xmlrpc

Use the XML-RPC RemoteAdmin interface with perl: [[Users:Thomax:perl-xmlrpc]]