68 lines
2.5 KiB
Markdown
68 lines
2.5 KiB
Markdown
# diaspora* federation library
|
|
|
|
**a library that provides functionalities needed for the diaspora* federation protocol**
|
|
|
|
[](https://travis-ci.org/SuperTux88/diaspora_federation)
|
|
[](https://codeclimate.com/github/SuperTux88/diaspora_federation)
|
|
[](https://codeclimate.com/github/SuperTux88/diaspora_federation/coverage)
|
|
[](https://gemnasium.com/SuperTux88/diaspora_federation)
|
|
[](https://inch-ci.org/github/SuperTux88/diaspora_federation)
|
|
[](https://badge.fury.io/rb/diaspora_federation)
|
|
|
|
[Documentation](http://www.rubydoc.info/gems/diaspora_federation/) |
|
|
[Bugtracker](https://github.com/SuperTux88/diaspora_federation/issues)
|
|
|
|
## Library
|
|
|
|
The ```diaspora_federation``` gem provides the functionality for de-/serialization and de-/encryption of Entities
|
|
in the protocols used for communication among the various installations of Diaspora*
|
|
|
|
## Rails Engine
|
|
|
|
The ```diaspora_federation-rails``` gem is a rails engine that adds the diaspora* federation protocol to a rails app.
|
|
|
|
### Usage
|
|
|
|
Add the gem to your ```Gemfile```:
|
|
|
|
```ruby
|
|
gem "diaspora_federation-rails"
|
|
```
|
|
|
|
Mount the routes in your ```config/routes.rb```:
|
|
|
|
```ruby
|
|
mount DiasporaFederation::Engine => "/"
|
|
```
|
|
|
|
Configure the engine in ```config/initializers/diaspora_federation.rb```:
|
|
|
|
```ruby
|
|
DiasporaFederation.configure do |config|
|
|
# the pod url
|
|
config.server_uri = AppConfig.pod_uri
|
|
|
|
# the class to be used for a person
|
|
config.person_class = Person
|
|
end
|
|
```
|
|
|
|
## Development
|
|
|
|
**!!! This gem is currently under heavy development, so every release can contain breaking changes !!!**
|
|
|
|
If you want to help, please contact me, help is welcome.
|
|
|
|
After the first stable release, this repo will be moved to the [diaspora organization](https://github.com/diaspora/).
|
|
|
|
## Diaspora
|
|
|
|
a privacy-aware, distributed, open source social network
|
|
|
|
Links:
|
|
[Project site](https://diasporafoundation.org) |
|
|
[Wiki](https://wiki.diasporafoundation.org)
|
|
|
|
## License
|
|
|
|
This gem is published under the terms of the "GNU Affero General Public License". See the LICENSE file for the exact wording.
|