|
|
| Line 1: |
Line 1: |
| − | In the .toml file you'll find all adjustable settings for Titan. Everything from the encryption layer in a group, to which files you share.
| + | Tes |
| − | | |
| − | '''Please note:''' Not all elements here are in your .toml file, and they don't need to! Titan will automatically create missing fields if changed in-app.
| |
| − | | |
| − | == global ==
| |
| − | | |
| − | :<code>user_colors</code> defines {insert some smart sentence here}
| |
| − | :<code>active_tab</code> defines which tab were last active when you close the app. '''Default = 0'''
| |
| − | :<code>auto_open</code> defines whether tabs should be auto-opened when there's activity in them (e.g. download tab). '''Default = 1'''
| |
| − | :<code>statusbar</code> defines whether the statusbar should be visible or not. '''Default = 1'''
| |
| − | :<code>timestamps</code> defines whether timestamp should be visible or not. '''Default = 1'''
| |
| − | :<code>font_size</code> defines the size of all texts in the app. '''Default = 13'''
| |
| − | :<code>theme</code> defines the location of a CSS file to change the theme of Titan. '''Optional'''
| |
| − | :<code>upload_speed</code> defines the throttling speed of uploads in Mbps. '''Default = 0 (no throttle)'''
| |
| − | :<code>download_speed</code> defines the throttling speed of downloads in Mbps. '''Default = 0 (no throttle)'''
| |
| − | :<code>qt_geometry</code> is just some Qt gibberish to remember the size and location of different windows. '''No need to change this.'''
| |
| − | :<code>qt_state</code> is just some Qt gibberish to remember the size and location of different windows. '''No need to change this.'''
| |
| − | | |
| − | == client ==
| |
| − | | |
| − | :<code>name</code> is the name of your client.
| |
| − | :<code>threads</code> defines the amount of concurrent threads the app will use when transferring files. '''Default = 4'''
| |
| − | :<code>enabled</code> defines whether your client is enabled, and will automatically connect to the specified router once you open the app. '''Default = true'''
| |
| − | ::'''Note:''' this value will change depending on the state of your client when you close Titan. If your client is disconnected when you close the app, this value will become "false".
| |
| − | :<code>color</code> defines the color of your client.
| |
| − | | |
| − | === client.share ===
| |
| − | | |
| − | One <nowiki>[[client.share]]</nowiki> per folder/file shared.
| |
| − | | |
| − | :<code>path</code> defines the location of the folder or file you want to share.
| |
| − | :<code>enabled</code> defines whether you are actively sharing this file or folder when you are connected.
| |
| − | | |
| − | === client.router ===
| |
| − | | |
| − | :<code>port</code> is which port you will connect to. '''Default = 80'''
| |
| − | :<code>name</code> is the local name of the router. '''Optional'''
| |
| − | :<code>enabled</code> defines whether you'll connect or not when you start the app. '''Default = true'''
| |
| − | :<code>address</code> is the address (either a URL or IP) E.g. ''router.demonsaw.com'' or ''192.254.75.74''
| |
| − | :<code>password</code> defines a password for connecting to the router. Wrong password will make the router refuse connection. '''Default = ""'''
| |
| − | | |
| − | === client.option ===
| |
| − | | |
| − | :<code>mode</code> {insert smart sentence here as well}
| |
| − | :<code>timestamp</code> defines the time/date format to use in chat. '''12H format:''' "%I:%M:%S %p" '''24H format:''' "%H:%M:%S"
| |
| − | :<code>max_downloads</code> defines the max number of concurrent file downloads. '''Default = 4'''
| |
| − | :<code>salt</code> defines the salt to apply to the hashing of your shred files/folders. '''Optional'''
| |
| − | :<code>hash</code> defines the type of hashing you want to use for you shared files/folders. '''Default = md5'''
| |
| − | :<code>buffer_size</code> defines the amount of chunks your client requests to be buffered by the router. '''Default = 16'''
| |
| − | :<code>path</code> defines the default downloads path for your client. If none is specified, Windows will use "C:/Users/user/Downloads", and Linux will use "something".
| |
| − | :<code>chunk_size</code> defines the size (in bytes) of each chunk to request from uploaders.
| |
| − | ::'''Note:''' If you have a slow/intermittent connection, you should considering lowering this value. '''Default = 786432'''
| |
| − | :<code>max_uploads</code> defines the max number of concurrent file uploads. '''Default = 4'''
| |
| − | | |
| − | === client.group ===
| |
| − | | |
| − | One <nowiki>[[client.group]]</nowiki> per layer of encryption. All layers will be combined for increased security. You will '''NOT''' join several groups with several layers!
| |
| − | | |
| − | :<code>enabled</code> defines whether this certain layer is enabled and used or not. '''Default = true'''
| |
| − | :<code>cipher</code> defines the type of cipher you want to use for this layer. '''Default = aes'''
| |
| − | :<code>percent</code> defines the percent of the file/string/URL content you want to use. Nice to reduce when you have a large file. '''Default = 100.000'''
| |
| − | :<code>entropy</code> defines the entropy of your layer. This can be a file, plain text string, or the content of a URL (HTTPS not supported (yet)). '''Required!'''
| |
| − | :<code>key_size</code> defines the size of the key (in KB) used. '''Default = 256'''
| |
| − | :<code>salt</code> defines the salt to be used along with the entropy in this layer. '''Optional'''
| |
| − | :<code>hash</code> defines the type of hash to be used in this layer. '''Default = sha256'''
| |
| − | :<code>iterations</code> defines the number of iterations for this layer. Note that the whole hashing/salting process is repeated for the entropy, therefore bigger sized entropy will take very long with more iterations. '''Default = 1'''
| |
| − | | |
| − | === client.session ===
| |
| − | | |
| − | This is the options for the encryption of the session between you and the router.
| |
| − | | |
| − | :<code>cipher</code> defines the type of cipher you want to use for this session. '''Default = aes'''
| |
| − | :<code>algorithm</code> defines the type of algorithm to use when exchanging keys with the router. '''Default = dh'''
| |
| − | :<code>prime_size</code> defines the size of your prime (in KB). '''Default = 128'''
| |
| − | :<code>key_size</code> defines the size of the key (in KB). '''Default = 256'''
| |
| − | :<code>salt</code> defines the salt to be used. '''Default = ""'''
| |
| − | :<code>hash</code> defines the type of hash to use. '''Default = sha256'''
| |
| − | :<code>iterations</code> defines the number of iterations for this encryption. '''Default = 1'''
| |
| − | | |
| − | === client.verified ===
| |
| − | | |
| − | This field is normally absent, and will continue to be so until further notice...
| |
| − | | |
| − | | |
| − | == Router ==
| |
| − | | |
| − | If you want to run your own router, these are the settings you need to care about. Note that you might need to do some [https://en.wikipedia.org/wiki/Port_forwarding port forwarding] in order for others to connect to you.
| |
| − | | |
| − | :<code>enabled</code> defines whether the router is enabled or not. '''Default = true'''
| |
| − | :<code>threads</code> defines max threads that should be allocated to the router. '''Default = 128'''<br/>
| |
| − | ::'''Note:''' The more threads the more people can join the router (1 user will use around 2 threads or so).
| |
| − | :<code>name</code> defines the (local) name of your router.
| |
| − | :<code>address</code> defines the IP address your router should bind to. This should be "127.0.0.1", but can also be your internal IP.<br/>
| |
| − | ::'''Note:''' This is <u>NOT</u> the IP that others will use to connect to you with (unless they are on your local network). The IP others will have to use is you external IP, and can be found by simply searching for "What is my IP" on a search engine.
| |
| − | :<code>password</code> defines the password required for client to connect to your router. '''Optional'''
| |
| − | :<code>port</code> defines the port your router will bind to. '''Default = 8000'''<br/>
| |
| − | ::'''Note:''' Some operating systems restrict some port ranges (usually all ports < 1024). Default ports for HTTP & HTTPS are 80 & 443. For alternative ports, [https://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers click here].
| |
| − | | |
| − | === router.option ===
| |
| − | | |
| − | :<code>buffer_size</code> defines the size of your buffer. '''Default = 32'''
| |
| − | :<code>motd</code> defines the Message Of The Day, and is the message the router will send to a client that has successfully connected. '''Optional'''
| |
| − | :<code>redirect</code> defines an URL that a user will be redirected to if connecting through a browser. '''Optional'''
| |
| − | | |
| − | === router.room ===
| |
| − | | |
| − | This section creates a chat room available for anyone to join in the public group on your router. This room will not be available for anyone in a private group. One room is made for each copy of this section.
| |
| − | | |
| − | :<code>enabled</code> defines whether the room is enabled or not. '''Default = true'''
| |
| − | :<code>name</code> defines the name of the room as it is shown to connected clients.
| |
| − | :<code>color</code> defines the color of the room. Because colors. '''Example:''' "#ffe56ffe"
| |
| − | | |
| − | === router.router ===
| |
| − | | |
| − | This section defines your transfer router(s). Copy this section for however many transfer routers you want to use.
| |
| − | | |
| − | :<code>enabled</code> defines whether this transfer router should be enabled or not. '''Default = true'''
| |
| − | :<code>name</code> defines the (local) name of this transfer router.
| |
| − | :<code>address</code> defines the address of your transfer router.
| |
| − | :<code>port</code> defines the port to use for this transfer router. '''Default = 80'''
| |
