Compile: Difference between revisions

From Lundman Wiki
mNo edit summary
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
==The FXP.One clients==
Welcome to the FXP.One project.


This is a known list of [[FXP.One]] clients. If you make a new one, feel free to add it here.


Before you start, this is not just another FTP/FXP client. It does not
work that way.


=== WFXP ===


[[Image:wfxp1.png|right|thumb|100px|WFXP]]
FXP.One consists of an engine, and
[[Image:wfxp2.png|right|thumb|100px|WFXP]]
you would need (at least) one GUI to control it.


The HTML5 / WebSockets FTP client. This uses the new key1/key2 style WebSockets, which currently is only supported by Chrome. The other browsers will update their sockets in due time.


WFXP ships with FXP.One sources, and installs automatically with FXP.Oned daemon. It is currently the most convenience client to use with FXP.One. Simply connect to the HTTP socket of FXP.One (default is port 8886) with '''https://'''. Ie, SSL-HTTP.
==FXP.One engine==


Please be aware that there is an OpenSSL version interoperability problem. Chrome uses a newer openssl-1.x, which will not work with OpenSSL-0.9.8 or older libraries, when compression was compiled in.
The idea was to put all the hard code into an engine that is really
easy to interface with. This has worked surprisingly well, in that you
can FTP/FXP entirely by using "telnet". This means writing a client,
which is essentially just a Display Shell, quite trivial. This
includes people who wants to just script clients, like by using perl,
python and so on.


=== FXP.cOne ===
This also means you do NOT have to run the engine on the same machine that you run the GUI client(s).  


'''* FXP.cOne (CDK/ncurses client)'''
For example, if you had a stable host, perhaps even with a static IP
making the credentials for authentication easier, you could run the
engine there. Then connect to it by the client of your choice.


[[Image:fxp.cone.screen1.jpg|right|thumb|100px|FXP.cOne]]
You can disconnect this client (the engine will keep working if you do
not tell it to stop) and start a new (and possibly different) client
elsewhere, and resume control of your previous work.


This [[FXP.One]] client ships with the FXP.One packages and will be compiled automatically if '''./configure''' can find '''ncurses''' and the special version of '''CDK'''. Download the CDK library from [http://invisible-island.net/cdk/ http://invisible-island.net/cdk/]
But you can run the engine and client at the same time, and quitting
at the same time, making it appear like a normal FTP/FXP client.


Until the local site can be added the client, if you wish to create a '''local''' site, please use ''<local>'' as the setting for '''host''', '''user''' and '''pass'''.


'''If you are looking for a Windows binary, please download the bundle from the latest [[UFxp]] client'''


Status: Beta: Completely Functional, but missing much cosmetics. Knowns bugs exist.
==Compiling and Install the engine==
  % git clone https://github.com/lundman/FXP.One
  % cd FXP.One/
  % ./configure
  % make
  % make install


Now create your SSL keys


  % openssl req -new -x509 -nodes -out lion.pem -keyout lion.pem




Create your .FXP.One folder and copy lion.pem into it


  % mkdir .FXP.One && cp lion.pem .FXP.One/ 


=== clomps ===
Start the FXP.One engine


'''* clomps (console multiple site 'whats new?' query program, with auto-queue support)'''
  % FXP.One


[[Image:clomps.screen1.jpg|right|thumb|100px|clomps]]
(Please use gnuMake; which might be called make, gmake, gnumake etc on your system)


This [[FXP.One]] client ships with the FXP.One packages and will be compiled automatically. It is a console only application that connects to multiple servers, works out what entries are '''new''' since it last ran, and presents a matrix of where files/directories are, and are missing. It can also automatically '''mirror''' between sites, in multiple ways, using the pass- and skip- lists. It can setup up sequential mirroring (A->B, then B->C) or concurrent mirroring. (A->B and A->C).
This should always compile the '''FXP.One engine'''. If ''configure'' can find the correct '''CDK''' library and '''ncurses''' on your system it will also compile the '''ncurses''' client '''FXP.cOne'''. Otherwise it will skip compiling this client.


[[clomps_conf|Example]] configuration file for clomps
'''Openssl-devel'''If you see a error like this:
''checking whether we need extra options to link OpenSSL... configure: error: Found linkable OpenSSL in , but it doesn't run, even with -R.  Maybe specify another using --with-ssl-dir?''


=== clomps-irc ===
You will need to openssl-devel for your system. On most Red Hat Variants it can be done with yum.


yum -y install openssl-devel


An IRC bot auto trader. This client sits on an IRC channel of your choosing, looking for "New Release" triggers to automatically create queues. Makes trading, and keeping sites synchronised ridiculously easy.


[[clomps_irc|Example]] configure file for clomps-irc
If you want to run '''clomps-irc''' you will need libpcre and headers, so most likely the -dv version if there is one:


apt-get install libpcre3-dev








'''''SSL Issues'''''


=== Ixodes ===
If your trying to connect from your client and get errors about ssl it probably means that they versions of ssl you have on your engine and your client are not compatible.


This [[FXP.One]] client is a GTK GUI client made on Python by a colleague. This client was never released and was made as a test-case for the '''UFxp''' client.
For example on the client end we have ssl version OpenSSL 0.9.8e-fips-rhel5 and on the server and OpenSSL 09.8k on another. There are many reasons why this will not work and many more why it should. In this case you will need to compile OpenSSL 0.9.8K on the server you wish to use FXP.Oned on and build FXP.Oned against that version of ssl. It the example below we will build openssl-0.9.8k in a local directory and compile FXP.Oned to use it.  


Status: deprecated.
To do this go to the openssl.org downloads page and download the version you want to use.
http://openssl.org/source/
wget http://openssl.org/source/openssl-0.9.8k.tar.gz
tar -xvzf openssl-1.0.0g.tar.gz
cd openssl-1.0.0g
./config -shared
make


Now go back to your FXP.Oned directory,
make clean
./configure LIBS=-ldl --with-ssl-dir=/home/erin/srcs/openssl-1.0.0g
make
make install


=== UFxp ===
==Running the engine==


This [[FXP.One]] client is a Ultimate++ GUI client. This is an external client and the most complete GUI client at the moment. This is most likely what new users wants to use, unless they are in a console only environment. Please see the [[UFxp]] home page for more information.


Status: beta, fully functional.
'''You will most likely need to create an SSL certificate for the engine since the default is only to accept secure connections.'''


[[Image:ufxp.screen1.jpg|right|thumb|100px|UFxp]]
 
Since the engine will be saving your remote FTP site information, as
well as any User/Passwords you chose on disk, you should consider
encrypting these files.
 
FXP.One engine will do this for you. When you start the engine, it
will as for a "Key". This is the Key that it will use to encrypt all
its data files. If you do not want encryption, just press return.
 
For the first time you run FXP.One, just make up whatever Key you
want.
 
When you start the engine in future, you have to specify the correct
Key or it will not be able to read your data files. (And you will not
be able to login).
 
To start again, you need to delete all .FXP.One files, and the engine
will create these again.
 
When the user file does not exist, the FXP.One engine will
automatically create a login as "admin" with password "admin".
 
 
NOTE: If you edit .FXP.One.settings file, you can change the option
"ssl=1". By default it will only allow SSL connections. If you change
it to "ssl=0" you make it optional. This allows you to telnet to the
engine should you wish to check it out. Please read the
"engine/API.txt" for more information on the FXP.One protocol.
 
NOTE: Please be aware that all skiplist, movefirstlist and passlists
are separated by the "/" character.
That is, "fmovefirst=*.sfv/*.nfo".

Latest revision as of 01:27, 1 May 2015

Welcome to the FXP.One project.


Before you start, this is not just another FTP/FXP client. It does not work that way.


FXP.One consists of an engine, and you would need (at least) one GUI to control it.


FXP.One engine

The idea was to put all the hard code into an engine that is really easy to interface with. This has worked surprisingly well, in that you can FTP/FXP entirely by using "telnet". This means writing a client, which is essentially just a Display Shell, quite trivial. This includes people who wants to just script clients, like by using perl, python and so on.

This also means you do NOT have to run the engine on the same machine that you run the GUI client(s).

For example, if you had a stable host, perhaps even with a static IP making the credentials for authentication easier, you could run the engine there. Then connect to it by the client of your choice.

You can disconnect this client (the engine will keep working if you do not tell it to stop) and start a new (and possibly different) client elsewhere, and resume control of your previous work.

But you can run the engine and client at the same time, and quitting at the same time, making it appear like a normal FTP/FXP client.


If you are looking for a Windows binary, please download the bundle from the latest UFxp client

Compiling and Install the engine

 % git clone https://github.com/lundman/FXP.One
 % cd FXP.One/
 % ./configure
 % make 
 % make install

Now create your SSL keys

 % openssl req -new -x509 -nodes -out lion.pem -keyout lion.pem


Create your .FXP.One folder and copy lion.pem into it

 % mkdir .FXP.One && cp lion.pem .FXP.One/   

Start the FXP.One engine

  % FXP.One 

(Please use gnuMake; which might be called make, gmake, gnumake etc on your system)

This should always compile the FXP.One engine. If configure can find the correct CDK library and ncurses on your system it will also compile the ncurses client FXP.cOne. Otherwise it will skip compiling this client.

Openssl-develIf you see a error like this:

checking whether we need extra options to link OpenSSL... configure: error: Found linkable OpenSSL in , but it doesn't run, even with -R.  Maybe specify another using --with-ssl-dir? 

You will need to openssl-devel for your system. On most Red Hat Variants it can be done with yum.

yum -y install openssl-devel


If you want to run clomps-irc you will need libpcre and headers, so most likely the -dv version if there is one:

apt-get install libpcre3-dev



SSL Issues

If your trying to connect from your client and get errors about ssl it probably means that they versions of ssl you have on your engine and your client are not compatible.

For example on the client end we have ssl version OpenSSL 0.9.8e-fips-rhel5 and on the server and OpenSSL 09.8k on another. There are many reasons why this will not work and many more why it should. In this case you will need to compile OpenSSL 0.9.8K on the server you wish to use FXP.Oned on and build FXP.Oned against that version of ssl. It the example below we will build openssl-0.9.8k in a local directory and compile FXP.Oned to use it.

To do this go to the openssl.org downloads page and download the version you want to use.

http://openssl.org/source/
wget http://openssl.org/source/openssl-0.9.8k.tar.gz
tar -xvzf openssl-1.0.0g.tar.gz 
cd openssl-1.0.0g 
./config -shared
make 

Now go back to your FXP.Oned directory,

make clean 
./configure LIBS=-ldl --with-ssl-dir=/home/erin/srcs/openssl-1.0.0g
make 
make install

Running the engine

You will most likely need to create an SSL certificate for the engine since the default is only to accept secure connections.


Since the engine will be saving your remote FTP site information, as well as any User/Passwords you chose on disk, you should consider encrypting these files.

FXP.One engine will do this for you. When you start the engine, it will as for a "Key". This is the Key that it will use to encrypt all its data files. If you do not want encryption, just press return.

For the first time you run FXP.One, just make up whatever Key you want.

When you start the engine in future, you have to specify the correct Key or it will not be able to read your data files. (And you will not be able to login).

To start again, you need to delete all .FXP.One files, and the engine will create these again.

When the user file does not exist, the FXP.One engine will automatically create a login as "admin" with password "admin".


NOTE: If you edit .FXP.One.settings file, you can change the option "ssl=1". By default it will only allow SSL connections. If you change it to "ssl=0" you make it optional. This allows you to telnet to the engine should you wish to check it out. Please read the "engine/API.txt" for more information on the FXP.One protocol.

NOTE: Please be aware that all skiplist, movefirstlist and passlists are separated by the "/" character. That is, "fmovefirst=*.sfv/*.nfo".