PyBriefcase Manual

Installation

  1. Unzip all of the files to a directory on your computer.
  2. Using an FTP program or by some other means, upload the briefcase folder to your / directory.
  3. Upload the briefcase folder in ToCGIBIN to your /cgi-bin/ directory.
  4. Upload the pybinstall.py file in ToCGIBIN to your /cgi-bin/ directory.
  5. Your directory structure should look like the following:
              /
              |-/briefcase/
                 |-/briefcase/res/ and all the files in it.
                 |-/briefcase/index.html
              |-/cgi-bin/
                  |-/cgi-bin/briefcase/ (the one in the ToCGIBIN folder)
                      |- briefcase.py, briefcaseread.py, conf.ini, files.ini
                  |-/cgi-bin/pybinstall.py
  6. Using an FTP manager or other such software, CHMOD (change permissions) of the /cgi-bin/pybinstall.py to 755 (also known as 0755).
  7. Go to http://yourdomain.com/cgi-bin/pybinstall.py and it will complete installation.
  8. If all goes well, please read the instructions below for configuration.

 

Configuration

All of the things that you need to configure are in the /cgi-bin/briefcase/conf.ini file. Please read the instructions below for a description of the options. Please note that you do NOT need to change anything inside brackets [] when editing the conf.ini file.


bdir - The ABSOLUTE path of the briefcase folder (/briefcase/, the one not in the cgi-bin folder). An absolute path is almost always not /. Rather, it depends on your webhost. Many webhosts would use something like: /home/username/public_html/briefcase/ where username is your username. If you do not know this, please ask your webhost's administration.


resdir - The RELATIVE path of the res folder. Unless you uploaded the /briefcase folder as a different name, you won't need to change this.


password - Your password.


dirfile - The ABSOLUTE path of the files.ini file. Again, using the example above, it might be something like /home/username/public_html/cgi-bin/briefcase/files.ini but it depends on your webhost.


upmax - The maximum size for a single uploaded file. Set this to 0 if you don't want any more files to be uploaded or -1 for no limit (which is strongly recommended that you don't do).


totalmax - The maximum size for the entire upload directory. Set this to 0 if you don't want any more files to be uploaded or -1 for no limit (which is strongly recommended that you don't do).


badext - Extensions (separated by ", " that are prohibited. You are strongly recommended to keep the ones listed, but you don't need to.


usepass - If you want to force the use of a password when reading the list of files, set this to "True" (with that capitalization and without the quotes). However, if you don't want to require a password, simply leave it at "False" and you are done.

 

Use

The use of PyBriefcase is fairly simple. Here is a basic overview of what to do.

Uploading:
To upload, simply go to your briefcase (http://yourdomain.com/briefcase/), type in your password, click Browse, and select the file that you want. Then, hit Submit to upload the file. If all goes well, a green checkmark will appear and by clicking on it, you will be taken back to your list of files.

Downloading:
Click on the name of a file to download it.

Deleting:
To delete a file, click Delete next to the file's name, type in your password and click Submit.