UFxp:Guide: Difference between revisions
No edit summary |
mNo edit summary |
||
(20 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
== UFxp Installation Guide == | == UFxp Installation Guide == | ||
This guide is mostly geared toward Windows binary downloaders. The general steps will still apply for Unix users, but not the specific commands. | This guide is mostly geared toward Windows binary downloaders. The general steps will still apply for Unix users, but not the specific commands. | ||
# Unzip the binary package somewhere. I will assume C:/UFxp/ as an example. Don't run the client yet. | # Unzip the binary package somewhere. I will assume ''C:/UFxp/'' as an example. Don't run the client yet. | ||
# UFxp/FXP.One comes with a sample OpenSSL certificate, this is to make quick-tests faster. However, you should not keep running with this certificate! If you have [[Certs|generated]] your own cert, please copy it into the folder now. | |||
# UFxp/FXP.One comes with a sample OpenSSL certificate, this is to make quick-tests faster. However, you should not keep running with this certificate! If you have generated your own cert, please copy it into the folder now. | |||
# Run the client. (double click UFxp.exe). | # Run the client. (double click UFxp.exe). | ||
# You will be presented with a "Connect to FXP.One" dialog. Since the engine and clients are separate, they can run on separate servers. However, you can also '''Spawn''' it on local machine which will give you the familiar FTP-like client. | |||
# The '''SpawnKey:''' This key is used to encrypt the files that the FXP.One engine saves. If you chose to use this feature, and we recommand that you do, you will have to supply it every time you '''Spawn''' the FXP.One engine. In this example, we will use a '''SpawnKey''' of "hello". Type "hello" into '''SpawnKey''' entry. Leave '''User''' and '''Pass''' as default (it is admin/admin). And click OK. | |||
:<u> You should see a message similar to: </u> | |||
FXP.Oned version 1.1 build 733 protocol 1.3, SSL is optional | FXP.Oned version 1.1 build 733 protocol 1.3, SSL is optional | ||
Line 21: | Line 18: | ||
Authorization Successful. | Authorization Successful. | ||
The final line there is very important. If it can not authenticate, do not try to use the UFxp client. It will only | ''The final line there is very important. If it can not authenticate, do not try to use the UFxp client. It will only'' '''''pretend''''' ''to work, but will do nothing!'' | ||
# If you authenticated successfully, use menu File / Change Password to change the default of admin/admin to a password of your chosing. Please do this, otherwise anyone can connect to your FXP.One engine. | # If you authenticated successfully, use menu File / Change Password to change the default of admin/admin to a password of your chosing. Please do this, otherwise anyone can connect to your FXP.One engine. | ||
# Use menu Control / Site Manager to Add your first sites. We will eventually go into more details about [[UFxp:Sites|Sites]. | |||
Normal use, you would connect both sides, queue some items, and click '''Go'''. One important distiction here, is that once you have clicked '''Go''' the client ''no longer owns the sites or queue''. It is now controlled by the FXP.One engine. To appear familiar to most users, we update the log windows and queue windows still. However, the client is ready to connect to new sites. If you do, it will clear the queue window. | |||
To see all active queues that the FXP.One engine is working on, use Control / Queue List. It will display the current queues, their status (Processing / Idle) and the last file's transfer speed. | |||
You can '''Clear''' any queue, active or not which will release it and stop it processing. | |||
If you click on '''Grab''' you will attempt to re-gain control over the queue with the client. If the queue is idle, you can start using any site still connected, and more items to the queue etc. If the queue is Processing, it will load the queue into the queue window to let you do simple queue operations. (Such as Move-To-Top, Delete etc). | |||
=== Troubleshooting === | |||
* Since FXP.One is a background process, and if you are having troubles Authenticating with it, you have no way to kill the process. Please use the Process View to stop any running FXP.One engines before you attempt to Spawn a new engine. | |||
* You can delete the FXP.One users file for the engine to recreate the default "admin/admin" login, however, if you do not have the correct '''SpawnKey''' it will not be able to read the sites file. If you lose your '''SpawnKey''' you will have to delete your sites file as well, and recreate all sites. | |||
* If you wish to allow plain-text conenctions to the engine (if you wish to use the API to write your own tools) edit the "FXP.One.settings" file and change | |||
COMMAND_SSL_ONLY=0 | |||
You will need to relaunch the engine after changing. |
Latest revision as of 02:06, 15 June 2007
UFxp Installation Guide
This guide is mostly geared toward Windows binary downloaders. The general steps will still apply for Unix users, but not the specific commands.
- Unzip the binary package somewhere. I will assume C:/UFxp/ as an example. Don't run the client yet.
- UFxp/FXP.One comes with a sample OpenSSL certificate, this is to make quick-tests faster. However, you should not keep running with this certificate! If you have generated your own cert, please copy it into the folder now.
- Run the client. (double click UFxp.exe).
- You will be presented with a "Connect to FXP.One" dialog. Since the engine and clients are separate, they can run on separate servers. However, you can also Spawn it on local machine which will give you the familiar FTP-like client.
- The SpawnKey: This key is used to encrypt the files that the FXP.One engine saves. If you chose to use this feature, and we recommand that you do, you will have to supply it every time you Spawn the FXP.One engine. In this example, we will use a SpawnKey of "hello". Type "hello" into SpawnKey entry. Leave User and Pass as default (it is admin/admin). And click OK.
- You should see a message similar to:
FXP.Oned version 1.1 build 733 protocol 1.3, SSL is optional Connection upgraded to secure: RC4-SHA SSLv3 Kx=RSA Au=RSA Enc=RC4(128) Mac=SHA1 Authorization Successful.
The final line there is very important. If it can not authenticate, do not try to use the UFxp client. It will only pretend to work, but will do nothing!
- If you authenticated successfully, use menu File / Change Password to change the default of admin/admin to a password of your chosing. Please do this, otherwise anyone can connect to your FXP.One engine.
- Use menu Control / Site Manager to Add your first sites. We will eventually go into more details about [[UFxp:Sites|Sites].
Normal use, you would connect both sides, queue some items, and click Go. One important distiction here, is that once you have clicked Go the client no longer owns the sites or queue. It is now controlled by the FXP.One engine. To appear familiar to most users, we update the log windows and queue windows still. However, the client is ready to connect to new sites. If you do, it will clear the queue window.
To see all active queues that the FXP.One engine is working on, use Control / Queue List. It will display the current queues, their status (Processing / Idle) and the last file's transfer speed.
You can Clear any queue, active or not which will release it and stop it processing.
If you click on Grab you will attempt to re-gain control over the queue with the client. If the queue is idle, you can start using any site still connected, and more items to the queue etc. If the queue is Processing, it will load the queue into the queue window to let you do simple queue operations. (Such as Move-To-Top, Delete etc).
Troubleshooting
- Since FXP.One is a background process, and if you are having troubles Authenticating with it, you have no way to kill the process. Please use the Process View to stop any running FXP.One engines before you attempt to Spawn a new engine.
- You can delete the FXP.One users file for the engine to recreate the default "admin/admin" login, however, if you do not have the correct SpawnKey it will not be able to read the sites file. If you lose your SpawnKey you will have to delete your sites file as well, and recreate all sites.
- If you wish to allow plain-text conenctions to the engine (if you wish to use the API to write your own tools) edit the "FXP.One.settings" file and change
COMMAND_SSL_ONLY=0
You will need to relaunch the engine after changing.