Outrun User Guide

Setting Up

Prerequisites

To make use of Outrun, you will need to download and install WireGuard on your client devices.

  1. WireGuard Installation

    For Ubuntu/Debian:

    sudo apt update
    sudo apt install wireguard
    

    For CentOS/RHEL:

    sudo dnf install wireguard-tools
    

    For macOS:

    brew install wireguard-tools
    

    For Windows:

  2. Verify Installation

    wg --version
    

Getting Started

Signing Up

  1. Navigate to the signup page
  2. Fill out the form with your desired email and password
  3. Click the "Sign Up" button
  4. You'll be redirected to the Dashboard

Account Setup

  1. Navigate to the login page
  2. Sign in using your credentials
  3. Accept the Terms of Service if you haven't already
  4. You'll be redirected to the Dashboard

Navigation

The application consists of several main sections:

  • Dashboard: Overview of your networks and security status
  • Networks: Manage your networks and clients
  • Security: Configure and monitor security features
  • Account: Manage your account settings and subscription
  • Help: Access documentation and contact support

Dashboard Features

  • Network Activity Map: Visual representation of your network connections
  • Security Trends: Graph showing security events over time
  • Active Clients: Real-time count of connected clients
  • Network Status: Overview of all network states

Managing Networks

Creating a New Network

  1. Go to the Networks page
  2. Click "New Network"
  3. Fill in the required information:
    • Network Name
    • Region
    • Security Features (optional)
  4. Click "Create"

Adding Clients

  1. Select a network from your Networks list
  2. Click "Add Client"
  3. Enter the client name
  4. Download the generated WireGuard configuration file
  5. Import the configuration file into your WireGuard client
  6. Mobile Only - You can also use the QR code to import the configuration file to a mobile device.

Managing Clients

  • View Client Status: Green indicator for active clients, red for inactive
  • Remove Client: Click the remove icon next to the client name
  • Update Client: Click the edit icon to modify client settings
  • Isolate Client: Click the lock icon to isolate the client from the network. This means the client will still continue to have intrnet connectivity, but will not longer be able to interact with any other clients on the network.

Security Features

Network Security Settings

Outrun provides several security features that can be enabled or disabled for each network:

Ad Blocking

  • Blocks advertisements and tracking domains at the network level
  • Toggle on/off in the Network Settings panel

Allow Internet

  • Allows internet access for the clients on ther network, or local only. This means that the clients will be able to talk to eachother, but not access resources outside the network.
  • Toggle on/off in the Network Settings panel

Intrusion Detection System (IDS)

  • Monitors network traffic for suspicious activity
  • Alerts you when potential threats are detected

Security Alerts

When you get a security alert, you have several options to deal with it. You can:

  • Dismiss Alert: Click the dismiss button to acknowledge the alert and take no action
  • Isolate Client: Click the lock icon to isolate the client from the network. This means the client will still continue to have internet connectivity, but will not longer be able to interact with any other clients on the network. This will allow you time to troubleshoot the cause of the alert.
  • Remove Client: Click the remove icon to remove the client from the network. This will remove the client from the network and delete the client configuration from the server. This will remove the threat from your network at the loss of your connection from the client.

Troubleshooting

Common Issues

  1. Connection Failed

    • Verify WireGuard is properly installed
    • Check your configuration file
    • Ensure your subscription is active
  2. Client Not Connecting

    • Verify the client configuration
    • Check network firewall settings
    • Ensure the network is active
  3. Security Alerts

    • Review security logs
    • Ensure that your DNS settings are using the wireguard DNS servers
    • Check client activity
    • Verify security feature settings

Support

For additional support:

  • Click the Help button to access documentation
  • Contact support at contact@outrun.cloud
  • Review system status for any ongoing issues

Best Practices

  1. Network Security

    • Enable all security features for maximum protection
    • Regularly check for security alerts
    • Keep WireGuard updated
  2. Client Management

    • Use descriptive client names
    • Remove unused clients
    • Regularly audit client access
  3. Account Security

    • Use strong passwords
    • Enable two-factor authentication
    • Review account activity regularly

Updates and Maintenance

  • System updates are automatic
  • Client updates will be notified through the dashboard
  • Scheduled maintenance windows will be announced in advance

Privacy and Data

  • All traffic is encrypted
  • No logs of client internet activity
  • Security logs are retained according to your plan settings