Version |
0.1.2 |
Github page |
http://github.com/Arachni/arachni-rpc |
Code Documentation |
http://rubydoc.info/github/Arachni/arachni-rpc/ |
Author |
Tasos "Zapotek" Laskos |
Twitter |
@Zap0tek |
Copyright |
2011-2012 |
License |
3-clause BSD |
</table>
## Synopsis
Arachni-RPC is a simple and lightweight Remote Procedure Call protocol which provides the basis for Arachni's Grid infrastructure.
This repository holds *only* the protocol specification although there currently are 2 (more like 1.5) available implementations:
- Arachni-RPC EM -- Uses EventMachine for network related operations and provides both a client and a server, this is the one used by Arachni.
- Arachni-RPC Pure -- Provides a synchronous client using pure Ruby OpenSSL sockets and has no 3rd party dependencies.
## Features
- Extremely lightweight
- Very simple design
- Token-based authentication
## Installation
I can't think of a lot of uses for manually installing the protocol specification
(it'll most likely be installed as a dependency for some other project) but in case you want to some instructions follow.
### Gem
```gem install arachni-rpc```
### Source
If you want to clone the repository and work with the source code:
git co git://github.com/arachni/arachni-rpc.git
cd arachni-rpc
rake install
## Running the Specs
In order to run the specs you must first install RSpec:
gem install rspec
Then:
rake spec
## Protocol specifications
You can find that information in the [Wiki](https://github.com/Arachni/arachni-rpc/wiki).
## Bug reports/Feature requests
Please send your feedback using Github's issue system at
[http://github.com/arachni/arachni-rpc/issues](http://github.com/arachni/arachni-rpc/issues).
## License
Arachni-RPC is provided under the 3-clause BSD license.
See the [LICENSE](file.LICENSE.html) file for more information.