2,032
edits
PHP Uploads: Difference between revisions
m
→MaxConcurrentUploads
| (10 intermediate revisions by 3 users not shown) | |||
|
== What is it? ==
In
It uses the HTTPS or HTTP protocol for transferring file data. It requires that you have a PHP enabled web server (most are), and that you upload a small PHP file to the root folder of your web site.
It can transfer both text and binary files.
If the ''upload.php'' file is installed for CMX and the protocol works for CMX then it will also work for CUtils and the file locations will be relative to the location of the ''upload.php'' file (which therefore will be the root location of your website).
'''Note''': It is not a requirement to change to using the PHP Upload method. The previous FTP/FTPS/SFTP methods remain fully supported and operational.
== Is it secure? ==
* It reduces bandwidth.
:* Unlike FTP which uploads the whole file each time, the PHP upload can send incremental data. For the default web site, most the data is the graph files and every update each entire file is sent over FTP every time just to add one new data point. Using the PHP upload, just that new data point is sent for each file, and the PHP script appends it to the existing file on your server.
:* If any updates fail, then only the cumulative data since the last successful transfer is sent.
:* It uses data compression over the network
== Disadvantages? ==
* It requires PHP support from your web provider - though most do
* Some web providers may not permit all the PHP methods that are required to implement this method
* You need to change your upload paths to use the new method - make a copy of your Cumulus.ini and your cumulusutils.ini file so you can easily revert
== Configuration ==
#Copy the '''/webfiles/upload.php''' to your web server, place it in the root folder of the default web site along with the index.html files etc
#You will need to update the paths for the NOAA Reports (it probably needs to be just “Reports”)
#Amend the paths of any Extra Files you upload (it probably needs to be just the remote file name)
#The uploads should start working!
#You can now disable all the "Create local" options for files in Internet Settings|Interval Settings. Local copies of the files created in the /web folder are no longer required
Changing this to ''false'' means the script will be allowed to create files anywhere in server file system that the PHP process has write permissions.
This option should only be used if you are certain, you need it, and ideally you can restrict the PHP process file system permissions to the areas you want data written.
=== CumulusUtils ===
The CUtils inifile parameter ''UploadDir'' specifies a subdirectory for CUtils relative to the webroot (the location of ''upload.php'') without any specification of the URL (as that is implicit in the use of ''upload.PHP'' as specified in ''Cumulus.ini''). If you wish all files to be transferred into the same directory as specified by CMX, then leave ''UploadDir'' empty.
If you run ''CumulusUtils'' for ''[[Website Generator|website]]'' without [[Thrifty - Cutils Command Qualifier|Thrifty]] it may generate a lot of files which need to be uploaded. So many that your server may refuse uploads at a certain point. To avoid the uploads to fail CUtils has two optimisations for the PHP upload protocol:
==== MaxConcurrentUploads ====
Just like you can in CMX, you may define the number of concurrent downloads which your server can handle. The parameter ''MaxConcurrentUploads'' defaults to no value which means it takes the value you defined in CMX. IIf you give this parameter a value, that value overrides the CMX value.
==== delayMilliSeconds ====
Some servers have a limit to the number of HTTP Post requests can be handled (e.g. 10 per second). If that is the case you need to define a delay value for the time between uploads. This is defined with the
''delayMilliSeconds'' parameter which defaults to 0 meaning the uploads secced each other as fast as possible.
== Cumulus.ini ==
These entries would normally be set via the Internet Settings configuration screen.
The ''upload.php'' procedure file can be copied to any location you wish but the following ''CMX ini file parameters'' determine its operation and need to reflect its true location and CMX configuration (in case you are running more than one instance):
== Potential Issues - Technical! ==
=== File Permissions ===
On my Linux self-hosting server, I found I had not given the PHP process write permissions on the folders holding my web site. What I did is (and this may not be the best or only method)...
:1. Create a new user group - webwriters - and add my existing user 'pi' and 'www-data' (the user PHP and the web server run under) to that group:
<pre>
> sudo addgroup webwriters
> sudo usermod -a -G webwriters www-data
> sudo usermod -a -G webwriters pi
</pre>
:2. Restart the web server and PHP-FPM to pick up the new group membership
<pre>
> sudo service nginx restart
> sudo service phpN.N-fpm restart
</pre>
:3. Then changed the group associated with the web folder(s)
<pre> > sudo chown -R :webwriters /var/www/mywebsite</pre>
:4. Finally change the permissions for webwriters group on the folder
<pre>
> sudo chmod -R g+rwx /var/www/mywebsite
> sudo chmod -R o-wx,o+r /var/www/mywebsite
</pre>
You can check what user PHP is running under with a simple script...
<code><?php echo `whoami`; ?></code>
Or, you can use the "top" or "htop" command, and look for the service there - check your web server too!
| |||