Difference between revisions of "Platform Team/Sugar Network/Implementation"

From Sugar Labs
Jump to navigation Jump to search
Line 16: Line 16:
 
All [[Sugar_Network/Concept#Resources|resources]] are being represented as Active Document's classes, resource objects as Active Document's objects.
 
All [[Sugar_Network/Concept#Resources|resources]] are being represented as Active Document's classes, resource objects as Active Document's objects.
  
−
== Instance ==
+
== Usage ==
 +
 
 +
=== Public instance ===
  
 
Testing instance is {{Code|api.network.sugarlabs.org}}. It support HTTPS connections using StartSSL certificate.
 
Testing instance is {{Code|api.network.sugarlabs.org}}. It support HTTPS connections using StartSSL certificate.
  
 
Add the {{Code|18.85.44.120 api.network.sugarlabs.org}} IP to {{Code|/etc/hosts}} file.
 
Add the {{Code|18.85.44.120 api.network.sugarlabs.org}} IP to {{Code|/etc/hosts}} file.
 +
 +
=== Local instance ===
 +
 +
Attach [http://download.sugarlabs.org/packages/Server:/Factory/ Server:Factory] repository. For Ubuntu repositories, download GPG key:
 +
 +
wget -qO- <REPO-URL>/Release.key | sudo apt-key add -
 +
 +
And install {{Code|sugar-network-server}} package.
 +
 +
To configure server, tweak configuration file (by default, server keep all data in {{Code|/var/lib/sugar-network}}):
 +
 +
/etc/sugar-network.conf
 +
 +
To start server:
 +
 +
/etc/init.d/sugar-network start
  
 
== Todo ==
 
== Todo ==

Revision as of 01:29, 7 March 2012

Summary

The requirements:

  • Implement the initial server in a short period of time;
  • Server should work on XO laptops;
  • System should support synchronisation between distributed servers and provide full featured text search.

That's why using Active Document to:

  • Server should be as simple/lightweight as possible;
  • No SQL, just NoSQL;
  • Since server should support full featured text search, use Xapian and keep it as a "NoSQL replacement" with storing data directly in files system;
  • If server will start serving users from the Internet and current implementation won't manage to handle multiple requests, another implementation might be created.

All resources are being represented as Active Document's classes, resource objects as Active Document's objects.

Usage

Public instance

Testing instance is api.network.sugarlabs.org. It support HTTPS connections using StartSSL certificate.

Add the 18.85.44.120 api.network.sugarlabs.org IP to /etc/hosts file.

Local instance

Attach Server:Factory repository. For Ubuntu repositories, download GPG key: 

wget -qO- <REPO-URL>/Release.key | sudo apt-key add -

And install sugar-network-server package.

To configure server, tweak configuration file (by default, server keep all data in /var/lib/sugar-network): 

/etc/sugar-network.conf

To start server: 

/etc/init.d/sugar-network start

Todo

  • Network notifications framework to, e.g., let client cache resources and refetch them only on updates. Reuse existing or implement something similar to Facebook's real-time updates.
  • Support collaborative work on Wiki pages for different resources.

Getting involved

Retrieved from "https://wiki.sugarlabs.org/index.php?title=Platform_Team/Sugar_Network/Implementation&oldid=76296"