Skip to content
Klutch.sh Docs

Deploying RetroShare

Introduction

RetroShare is a decentralized, encrypted communication and file sharing platform that operates on a friend-to-friend (F2F) network. Unlike traditional centralized services, RetroShare creates encrypted connections directly between trusted friends, ensuring complete privacy and security for your communications.

Key highlights of RetroShare:

  • Decentralized Network: No central server required for communication
  • End-to-End Encryption: All communications encrypted with OpenSSL
  • Friend-to-Friend: Connect only with trusted contacts
  • Multiple Services: Chat, forums, channels, file sharing, and VoIP
  • Anonymity Layer: Optional Tor-like anonymity through the I2P network
  • File Sharing: Secure file transfer between friends
  • Forums and Channels: Decentralized discussion boards
  • Instant Messaging: Encrypted chat with offline messaging
  • Email-Like Messaging: Asynchronous message delivery
  • Cross-Platform: Available on Windows, Linux, macOS, and Android
  • Open Source: GPL-licensed with transparent cryptography

This guide walks through deploying the RetroShare web interface on Klutch.sh using Docker.

Why Deploy RetroShare on Klutch.sh

Deploying RetroShare on Klutch.sh provides several advantages:

Simplified Deployment: Deploy a RetroShare node without complex network configuration.

Persistent Storage: Attach persistent volumes for your RetroShare profile and shared files.

Always-On Node: Keep your RetroShare node online 24/7 for better network connectivity.

HTTPS by Default: Klutch.sh provides automatic SSL for the web interface.

Prerequisites

Before deploying RetroShare on Klutch.sh, ensure you have:

Preparing Your Repository

Create a GitHub repository containing your Dockerfile for RetroShare deployment.

Repository Structure

retroshare-deploy/
├── Dockerfile
└── .dockerignore

Creating the Dockerfile

Create a Dockerfile in the root of your repository:

FROM retroshare/retroshare:latest


# Set environment variables
ENV RS_WEBUI_PASSWORD=${RS_WEBUI_PASSWORD}


# Create data directories
RUN mkdir -p /data/.retroshare


# Expose ports
# 9090 - Web UI
EXPOSE 9090


# The base image includes the default entrypoint

Environment Variables Reference

VariableRequiredDescription
RS_WEBUI_PASSWORDYesPassword for web interface access

Deploying RetroShare on Klutch.sh

    Generate a Secure Password

    Create a strong password for web interface access:

    Terminal window
    openssl rand -base64 24

    Push Your Repository to GitHub

    Commit and push your Dockerfile to GitHub.

    Create a New Project on Klutch.sh

    Navigate to the Klutch.sh dashboard and create a new project with a descriptive name like “retroshare”.

    Create a New App

    Within your project, create a new app. Connect your GitHub account and select the repository containing your RetroShare Dockerfile.

    Configure HTTP Traffic

    In the deployment settings:

    • Select HTTP as the traffic type
    • Set the internal port to 9090

    Set Environment Variables

    Add the following environment variables:

    VariableValue
    RS_WEBUI_PASSWORDYour generated password

    Attach Persistent Volumes

    Add the following volume:

    Mount PathRecommended SizePurpose
    /data/.retroshare10 GBProfile data and shared files

    Deploy Your Application

    Click Deploy to start the build process.

    Access RetroShare

    Once deployment completes, access the RetroShare web interface at your app URL.

Initial Configuration

Creating Your Identity

  1. Access the web interface
  2. Create a new RetroShare identity
  3. Generate your PGP key pair
  4. Configure your profile settings

Adding Friends

  1. Exchange certificates with trusted friends
  2. Add friend certificates to your node
  3. Wait for connection establishment
  4. Friends will appear online when both nodes are running

Using Services

  • Chat: Direct messaging with connected friends
  • Forums: Subscribe to and create discussion boards
  • Channels: Share content through channels
  • File Sharing: Share files with your network

Security Considerations

  • Keep your private key secure and backed up
  • Only add trusted individuals as friends
  • Use strong passwords for web interface access
  • Consider using Tor hidden services for additional anonymity

Additional Resources

Conclusion

Deploying RetroShare on Klutch.sh gives you a private, decentralized communication platform that operates independently of central servers. With end-to-end encryption and friend-to-friend networking, RetroShare provides genuine privacy for your digital communications while Klutch.sh handles the infrastructure.