Installing Orbited
Orbited is written in Python and requires Python 2.5 or newer (for a workaround for <2.5, see ticket #24 and this discussion). Orbited also requires Twisted, which it installs automatically on most platforms (and is otherwise installed trivially). Additionally, from 0.5 and onwards Orbited enables a revolutionary interaction model centered around the TCPSocket. Note: to install Orbited on Windows see the Windows instructions.
Python
First of all, let's install Python. Download and run the installer for your system, and you'll be good to go.
For more detailed instructions, please refer to python.org's help page.
Twisted
Twisted is a dependency of Orbited 0.6. Installers are available on their website.
Orbited
There are two ways to install Orbited itself: from an official release and from the development version.
Installing an Official Release
Although it is not required, setuptools is by far the easiest way to get an official release of Orbited running.
1. Download ez_setup.py
2. Go to a command line, navigate to the directory containing ez_setup.py, and type:
python ez_setup.py setuptools
Then, to install orbited, go to a command line and type:
easy_install orbited
The configuration file must be downloaded separately from SVN and placed in
/etc/
The configuration file for 0.6 is located at /trunk/daemon/orbited.cfg
Installing the Development Version
The first step is to checkout the development version from the repository using svn:
svn checkout http://orbited.org/svn/orbited/trunk/ [path]
Then run the following command from the directory you checked out Orbited to:
python setup.py install
Finally, the configuration file orbited.cfg in the main checkout directory needs to be copied to /etc/
Verify the Installation Works
To make sure the installation was successful, run this simple test:
Enter your Python interpreter:
python
See whether Orbited loads:
import orbited
If you don't see an error, the installation worked! Now you can run Orbited by exiting the Python interpreter and typing orbited (see Deployment for more details). Check out the demos and tests by going to http://localhost:8000/static (replace localhost with a different address if necessary). Orbited can be configured by editing the orbited.cfg file.
Post-Installation Notes
Orbited encodes data as JSON, using a library called demjson. If you are looking for ways to speed up your project, try installing a super-fast C-based JSON library such as cjson or simplejson. Remember easy_install? It works here, too:
easy_install cjson
or
easy_install simplejson
Orbited is installed, and you're ready to build fast, scalable, cutting-edge network applications for the web. Congratulations!