Difference between revisions of "Vines"

From diaspora* project wiki
Jump to: navigation, search
(Style police ;))
Line 1: Line 1:
This wiki-page is about setting up vines on your Diaspora installation.
+
{{Work_in_progress}}
 +
{{Note|Report issues and suggestions to the Vines server at https://github.com/diaspora/vines/issues}}
 +
{{Note|The pull request integrating this with Diaspora is at https://github.com/diaspora/diaspora/pull/5073}}
  
'''Bugs''': Any bugs or suggestions related to the Vines server goes [https://github.com/diaspora/vines/issues here...]!
+
This wiki-page is about setting up [http://getvines.org Vines] on your Diaspora installation.
  
Related Diaspora pull-request [https://github.com/diaspora/diaspora/pull/5073 diaspora/diaspora#5073]
+
{{Quote|Vines is an XMPP chat server that connects you with large clusters of machines as easily as chatting with a friend.<br>
Vines is an XMPP chat server that connects you with large clusters of machines as easily as chatting with a friend.<br>
+
  It's a new, simpler way to manage your servers in the cloud or the data center.| http://www.getvines.org/}}
  It's a new, simpler way to manage your servers in the cloud or the data center.
 
  
 
= Installation =
 
= Installation =
Line 11: Line 12:
 
== Set up branch ==
 
== Set up branch ==
  
Checkout or merge xmpp chat feature branch from zauberstuhl/diaspora.git:
+
Checkout or merge XMPP chat feature branch from zauberstuhl/diaspora.git:
 +
 
 +
<syntaxhighlight lang="bash">
 
  git remote add zauberstuhl https://github.com/Zauberstuhl/diaspora.git
 
  git remote add zauberstuhl https://github.com/Zauberstuhl/diaspora.git
 
  git fetch zauberstuhl && git checkout -b xmpp_chat_feature zauberstuhl/xmpp_chat_feature
 
  git fetch zauberstuhl && git checkout -b xmpp_chat_feature zauberstuhl/xmpp_chat_feature
 +
</syntaxhighlight>
  
'''Warning''': xmpp_chat_feature-branch is based upon Diaspora develop-branch!
+
{{Serious|xmpp_chat_feature-branch is based upon Diaspora develop-branch!}}
  
  
 
== Update ==
 
== Update ==
  
All required dependencies are included in your Gemfile. The only thing you have to do now is follow the [https://wiki.diasporafoundation.org/Updating Updating-article]!
+
All required dependencies are included in your <tt>Gemfile</tt>. The only thing you have to do now is follow the [[Updating|Update guide]]!
In short, execute follwing:
+
In short, execute following:
  
 +
<syntaxhighlight lang="bash">
 
  export RAILS_ENV=development
 
  export RAILS_ENV=development
 
  bundle install
 
  bundle install
 
  bundle exec rake assets:precompile
 
  bundle exec rake assets:precompile
 
  bundle exec rake db:migrate
 
  bundle exec rake db:migrate
 +
</syntaxhighlight>
  
 
= Configuration =
 
= Configuration =
  
You'll find all required configuration parameters in diaspora.yml.example. If you'd like to activate the chat feature<br>
+
You'll find all required configuration parameters in <tt>diaspora.yml.example</tt>. If you'd like to activate the chat feature
you have to copy paste the chat section from diaspora.yml.example to your actual diaspora.yml configuration file and<br>
+
you have to copy paste the chat section from <tt>diaspora.yml.example</tt> to your actual <tt>diaspora.yml</tt> configuration file and
 
activate the chat globally:
 
activate the chat globally:
<nowiki>
+
 
 +
<syntaxhighlight lang="yaml">
 
   chat:
 
   chat:
 
     enabled: true
 
     enabled: true
</nowiki>
+
</syntaxhighlight>
 +
 
 +
If you have already a working XMPP server and need only the front-end:
  
If you have already a working xmpp server and need only the front-end:
+
<syntaxhighlight lang="yaml">
<nowiki>
 
 
   chat:
 
   chat:
 
     enabled: true
 
     enabled: true
 
     server:
 
     server:
 
       enabled: false
 
       enabled: false
</nowiki>
+
</syntaxhighlight>
  
It is also possible to configure the port and address of the client-to-server, server-to-server and the BOSH service.<br>
+
It is also possible to configure the port and address of the client-to-server, server-to-server and the BOSH service.
You'll also find the required parameters in diaspora.yml.example with a small description.
+
You'll also find the required parameters in <tt>diaspora.yml.example</tt> with a small description.
  
 
= Run it =
 
= Run it =
  
 
If you are finished configuring the chat server you can start Diaspora as normal:
 
If you are finished configuring the chat server you can start Diaspora as normal:
 +
 +
<syntaxhighlight lang="bash">
 
  ./script/server
 
  ./script/server
 +
</syntaxhighlight>
  
Log into Diaspora and you should see the web client in the right corner.<br>
+
Log into Diaspora and you should see the web client in the right corner.
 
You can also log into it with your favorite desktop client like Pidgin.
 
You can also log into it with your favorite desktop client like Pidgin.
  
For that use your diaspora handle and your diaspora password.  
+
For that use your Diaspora ID and your Diaspora password.  
  
 
= Debugging =
 
= Debugging =
  
On default vines will log to log/vines.log and has a info-log-level set.<br>
+
On default Vines will log to <tt>log/vines.log</tt> and has a log level of <tt>info</tt> set.
Set the logging level to debug, info, warn, error, or fatal. The debug level logs all XML sent and received by the server.
+
Set the logging level to <tt>debug</tt>, <tt>info</tt>, <tt>warn</tt>, <tt>error</tt>, or <tt>fatal</tt>. The <tt>debug</tt> level logs all XML sent and received by the server.
<nowiki>
+
 
 +
<syntaxhighlight lang="yaml">
 
   chat:
 
   chat:
 
     server:
 
     server:
Line 69: Line 81:
 
         file: 'log/vines.log'
 
         file: 'log/vines.log'
 
         level: 'debug'
 
         level: 'debug'
</nowiki>
+
</syntaxhighlight>
 +
 
 +
 
 +
[[Category:Podmin]] [[Category:Installation]]

Revision as of 19:59, 14 September 2014

»» Work in progress
This article is a work in progress, it may contain incomplete or inaccurate information. There may be additional information on the talk page.
»» Note
Report issues and suggestions to the Vines server at https://github.com/diaspora/vines/issues
»» Note
The pull request integrating this with Diaspora is at https://github.com/diaspora/diaspora/pull/5073


This wiki-page is about setting up Vines on your Diaspora installation.

Vines is an XMPP chat server that connects you with large clusters of machines as easily as chatting with a friend.
It's a new, simpler way to manage your servers in the cloud or the data center.

Installation

Set up branch

Checkout or merge XMPP chat feature branch from zauberstuhl/diaspora.git:

 git remote add zauberstuhl https://github.com/Zauberstuhl/diaspora.git
 git fetch zauberstuhl && git checkout -b xmpp_chat_feature zauberstuhl/xmpp_chat_feature
»» Important
xmpp_chat_feature-branch is based upon Diaspora develop-branch!


Update

All required dependencies are included in your Gemfile. The only thing you have to do now is follow the Update guide! In short, execute following:

 export RAILS_ENV=development
 bundle install
 bundle exec rake assets:precompile
 bundle exec rake db:migrate

Configuration

You'll find all required configuration parameters in diaspora.yml.example. If you'd like to activate the chat feature you have to copy paste the chat section from diaspora.yml.example to your actual diaspora.yml configuration file and activate the chat globally:

  chat:
    enabled: true

If you have already a working XMPP server and need only the front-end:

  chat:
    enabled: true
    server:
      enabled: false

It is also possible to configure the port and address of the client-to-server, server-to-server and the BOSH service. You'll also find the required parameters in diaspora.yml.example with a small description.

Run it

If you are finished configuring the chat server you can start Diaspora as normal:

 ./script/server

Log into Diaspora and you should see the web client in the right corner. You can also log into it with your favorite desktop client like Pidgin.

For that use your Diaspora ID and your Diaspora password.

Debugging

On default Vines will log to log/vines.log and has a log level of info set. Set the logging level to debug, info, warn, error, or fatal. The debug level logs all XML sent and received by the server.

  chat:
    server:
      log:
        file: 'log/vines.log'
        level: 'debug'