Difference between revisions of "Router Setup"

From Titan Wiki
Jump to navigation Jump to search
(Oh yeah)
 
m (My jokes are so bad)
Line 11: Line 11:
 
;Note:
 
;Note:
 
:You might need to [https://en.wikipedia.org/wiki/Port_forwarding port forward] your specified port in order get external connections through your home router, depending on your home router.
 
:You might need to [https://en.wikipedia.org/wiki/Port_forwarding port forward] your specified port in order get external connections through your home router, depending on your home router.
 +
 +
==Running the Router==
 +
When you execute the binary (preferably with a .500 Magnum), you'll be given a terminal window, prompting you to with version info, and <code><Press '?' for help></code>
 +
 +
;You currently have 3 options in the terminal window:
 +
:<code>d</code> - Show you the Dashboard, with some info about your router.
 +
:<code>r</code> - Restart the router (and maybe fix some issues?).
 +
:<code>x</code> - Exit and terminate the router.
 +
 +
When you show your dashboard, it'll show you the name of the router(s), the <code>Address</code>, <code>Port</code>, <code>State</code>, and <code>Load</code>.
 +
This is all the information you can get from the command line interface.
 +
 +
<code>State</code> will always be either <code>OK</code> or <code>Error</code>. If the latter is present, you'll have to review your .toml file, or your user permissions (running the binary as an elevated user might help).
 +
 +
<!--<code>Load</code> indicates how many active threads you currently have. Each connected client will use 1 thread, and every transfer will use 1 additional thread (one for each upload and download). so 2 clients transferring a file between them will result in 4 active threads.<br/>
 +
When this value reaches the maximum - as specified in the .toml - clients will get an error when connecting/initiating transfers.--->

Revision as of 18:31, 29 July 2017

This page will describe how to set up your own router, and how to configure it optimally.

Quick Setup

You can download the router for all supported OS here. This is a .zip file, containing a folder for each OS. Within each of those folders, are the router binary, and a default .toml file.
To see what all the different TOML attributes do, check out the Titan.toml page.
What you need to change in order to just get it up and running, is simply the IP (to your own, local IP), and possibly the port.

For Linux users
Ports <1024 may be restricted to non-elevated users, so you might need to change the port in the .toml accordingly.
Note
You might need to port forward your specified port in order get external connections through your home router, depending on your home router.

Running the Router

When you execute the binary (preferably with a .500 Magnum), you'll be given a terminal window, prompting you to with version info, and <Press '?' for help>

You currently have 3 options in the terminal window
d - Show you the Dashboard, with some info about your router.
r - Restart the router (and maybe fix some issues?).
x - Exit and terminate the router.

When you show your dashboard, it'll show you the name of the router(s), the Address, Port, State, and Load. This is all the information you can get from the command line interface.

State will always be either OK or Error. If the latter is present, you'll have to review your .toml file, or your user permissions (running the binary as an elevated user might help).