pfioh startup

pfioh startup

Abstract

This page provides the startup instructions for pfioh, as well as what to expect/see once pfioh has started.

Startup

The pfioh service can be started either "on the metal" (i.e. assuming a local installation) or via a dockerized container.

Local installation "on the metal"

Recommended for: <>?

Local installation means it does not run as a service / daemon. As soon as you close the terminal the service stops.

To start the pfioh service assuming a local installation, run

pfioh --forever --httpResponse --storeBase=/tmp --createDirsAsNeeded

From a docker container

First, make sure that the latest version of the container is accessible;

docker pull fnndsc/pfioh

Then, if you are using a source repo, run the shadow helper script (with the same args) from the docker-bin dir -- note that this directory is in the repository source code. To use this command you must have cloned the repository and be in the base directory:

git clone https://github.com/FNNDSC/pfioh.git

and then

cd pfioh

followed by

docker-bin/pfioh --forever --httpResponse --storeBase=/tmp --createDirsAsNeeded

If you don't have the source repository, you can simply run this:

docker run --name pfioh -v /someDir:/store --rm -ti fnndsc/pfioh --forever --httpResponse --storeBase=/store --createDirsAsNeeded

The host directory /someDir is mounted to /store in the container, which is also the base storage directory of the process.

See the in-line help or the overview for information on each of the passed flags

What to expect

When started as above, the terminal should display something like:

        __ _       _
       / _(_)     | |
 _ __ | |_ _  ___ | |__
| '_ \|  _| |/ _ \| '_ \
| |_) | | | | (_) | | | |
| .__/|_| |_|\___/|_| |_|
| |
|_|


                            Path-File-IO-over-HTTP

           A simple IO handler that pushes/pulls file paths over http

                              -- version 1.2.4 --

    'pfioh' is a file/dir transfer tool, akin conceptually to 'ftp' or 'scp',
    that allows software agents to perform useful file transfers over http.

    'pfioh' handles HTTP REST-like requests on a given port -- it can accept
    incoming file data from a client, and can also return server-side file trees
    to a client.

    'pfioh' can also zip up/unzip file trees so that entire paths can be easily
    transferred.
    

        
              +-------------------------------------------------------+
              | NOTE THAT THIS SERVER DOES NOT CURRENTLY AUTHENTICATE |
              | AND WILL HONOR *ALL* FILE/PATH PUSH/PULL REQUESTS!    |
              +-------------------------------------------------------+
              

                   Listening on address:                            10.17.24.163
                      Listening on port:                                    5055
                  Server listen forever:                                    True
                  Return HTTP responses:                                    True


	Waiting for incoming data...

Note in the above example the service is listening on host 10.17.24.163:5055 which will be used in all subsequent examples.

--30--