Compile: Difference between revisions

From Lundman Wiki
No edit summary
mNo edit summary
 
(31 intermediate revisions by the same user not shown)
Line 19: Line 19:
python and so on.
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).  
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
For example, if you had a stable host, perhaps even with a static IP
making the credentials for authentication easier, you could run the
making the credentials for authentication easier, you could run the
engine there. Then connect to it by the client of you choice.
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
You can disconnect this client (the engine will keep working if you do
Line 32: Line 32:
at the same time, making it appear like a normal FTP/FXP client.
at the same time, making it appear like a normal FTP/FXP client.


==Compiling the engine==


  % cd FXP.One/engine
'''If you are looking for a Windows binary, please download the bundle from the latest [[UFxp]] client'''
  % gmake


(Please use gnuMake)
==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


make: build: Command not found
  % openssl req -new -x509 -nodes -out lion.pem -keyout lion.pem


^^-- You can safely ignore this error. It just means you do not have
 
my tiny "build" program that bumps the version in version.h
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-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?''
 
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==
==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
Since the engine will be saving your remote FTP site information, as
Line 78: Line 132:
are separated by the "/" character.  
are separated by the "/" character.  
That is, "fmovefirst=*.sfv/*.nfo".
That is, "fmovefirst=*.sfv/*.nfo".
==The FXP.One clients==
At the time of this document, there are only a few clients available, that come with the [[FXP.One]] package.
* FXP.cone (CDK/ncurses client)
* clomps (console multiple site 'whats new?' query program, with auto-queue support)
===FXP.cOne client===
* Lightweight, uses ncurses and CDK only.
* Handles multiple queues
* Repeatable SITE commands (just select all files, then issue SITE cmd)
Status: Beta: Completely Functional, but missing much cosmetics.
Probably the most complete client is the ncurses client. It uses CDK
and ncurses. but please note that should your OS come with CDK, it is
most likely either not current enough to work, or it is not the CDK
this client uses (there are 2 sets of ncurses CDK libraries.)
  % cd clients/FXP.cOne/
  % gmake
Please read the README.txt with the client.
===FXP.One clomps===
* Connects to all your FTP sites, and lists new items, where they are and where they are missing.
* Handles Incomplete and Ignored pattern as defined for each site.
* Can auto queue to automatically move new items
* Can cascade sites. Move A->B then B-C. Or, concurrently, A-B, A->C.
Status: Beta. Complete.
I made a console only application that will connect to multiple FTP
sites, work out what is new on each one of them, then build a matrix
displaying where they exist, are incomplete or missing. Optionally,
you can also specify a search pattern to find where there are hits.
New feature now includes auto-queuing for automatic mirroring support,
additional reject/accept patterns, as well as the ability to specify
which pass-number the mirror should occur on. This allows control over
cascaded mirroring. (A->B, B->C, C->D etc)
This client assumes you have already defined your FXP.One sites in the
engine ready to use.
  % cd clients/clomps/
  % gmake
==External Clients==
* Ixodes (Python GTK GUI client)
* UFxp (Ultimate++ GUI client, Windows, Unix)
===Ixodes===
This is a GTK GUI client made by a colleague. He has chosen not to release his client for the general public, but perhaps you should contact him and urge him otherwise.
===UFxp===
UFxp is a GUI client for FXP.One using the Ultimate++ widget toolkit. It works on Windows and little-endian Unix servers. Currently tested on NetBSD and Linux. Use [[CVS]] to obtain the latest sources.
Windows build: [[http://www.lundman.net/ftp/UFxp/UFxp-FXP.One-v0.02.zip UFxp-FXP.One-v0.02.zip]]

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".