Documentation:retroshare-nogui

From RetroShare
Jump to: navigation, search

retroshare-nogui has a remote control interface. This allows you to control a running retroshare-nogui from another computer, your Android phone, or from a web interface.

Contents

Requirements

You have to know :

For access from the internet, you have to know :

Setup according the OS

Setup on Linux

  1. Copy a working .retroshare config directory from an existing system. (There may be an alternate to this, but it seems to be required).
  2. Create a ssh-key. It will be used to encrypt the connection between retroshare-nogui and the remote client.
    Do not set a password, just press enter when asked.
    :ssh-keygen -t rsa -f rs_ssh_host_rsa_key
  3. Create a password hash. This password is only for remote control. It has nothing to do with your Retroshare password.
    :RetroShare-nogui -G
  4. Run retroshare-nogui and choose a port and a arbitrary username
    for SSH access
    RetroShare-nogui -X -S <port> -L <username> -P <passwordhash>
    for RPC access
    RetroShare-nogui -C -X -S <port> -L <username> -P <passwordhash>
Note: at the end of this page, there is a list of available RPC-clients

Setup on Windows

A. Find the folder

First you have to find the folder where retroshare-nogui.exe is :

  • You have the portable package? Then you probably know where retroshare-nogui is located. Continue with next step ("Create a ssh-key").
  • You used the installer?
Press Windows + r, type in %programfiles%/RetroShare, press enter
If this does not work, try %programfiles(x86)%/RetroShare

B. Create a ssh-key

Download and run puttygen.exe http://the.earth.li/~sgtatham/putty/latest/x86/puttygen.exe
Click on Generate to generate a new ssh-key
Click on Conversations->Export OpenSSH key
Yes, you want to save this key without passphrase
Navigate to the folder where retroshare-nogui is. Save the key as rs_ssh_host_rsa_key

C. Create a password hash. This password is only for remote control. It has nothing to do with your Retroshare password.

Press Windows + r, type in cmd, press enter
Use the command cd (change directory) to go the directory where retroshare-nogui is. Type in (or paste) one of the follow commands, then press enter
cd "c:/path/to/retroshare/folder"
cd %programfiles%/retroshare
cd %programfiles(x86)%/retroshare

use this command to create the password hash: retroshare-nogui -G

D. Run retroshare-nogui and choose a port and a arbitrary username

for SSH access :
retroshare-nogui -X -S <port> -L <username> -P <passwordhash>
for RPC access :
retroshare-nogui -C -X -S <port> -L <username> -P <passwordhash>
at the end of this page, there is a list of available RPC-clients

To create a shortcut, choose retroshare-nogui as destination, and add the arguments like above.

Access according the protocol

SSH access

If you know what SSH is, then you probably find out how to connect to retroshare-nogui.

MORE DETAILS ARE WELCOME !, PLEASE COMPLETE THIS WIKI.

retroshare-nogui has only a very basic terminal interface. For more control, use one of the RPC-clients below.

RPC access : list of clients

Personal tools
Namespaces

Variants
Actions
Navigation
External websites
Wiki
Toolbox