|
|
| (3 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| The 'Simple Website' setup is by far the easiest and quickest way to get your Cumulus data online. It uses the standard Cumulus web templates and the process is well documented in the Help files for Cumulus 1 under 'Setting Up your Website'. | | The 'Simple Website' setup is by far the easiest and quickest way to get your Cumulus 1.9.4 data online. It uses the standard Cumulus 1.9.4 web templates and the process is well documented in the Help files for Cumulus 1 under 'Setting Up your Website'. |
|
| |
|
| However this article may help further, and to some extent has been updated to also cover MX. | | However this article (which is {{Version badge 1}} only for the legacy software) may help further. |
| {{TOCright}} | | {{TOCright}} |
|
| |
|
| =If you run your own web server= | | =If you run your own web server= |
|
| |
|
| The assumption in this article is that FTP (protocol may vary for MX) is used to get files onto your web server. | | The assumption in this article is that FTP is used to get files onto your web server. |
|
| |
|
| <big>At present this article does not cover alternative of running your own web server and using copy to get files onto that web server.</big> | | <big>At present this article does not cover alternative of running your own web server and using copy to get files onto that web server.</big> |
| Line 16: |
Line 16: |
|
| |
|
| #You have File Transfer Process (FTP) webspace (i.e. your provider allows you to use FTP to place files in your webspace) | | #You have File Transfer Process (FTP) webspace (i.e. your provider allows you to use FTP to place files in your webspace) |
| #and an [[FTP tool]] (use this cross-reference to get more information) | | #and an [[FTP tools|FTP tool]] (use this cross-reference to get more information) |
|
| |
|
| From your webspace provider you will be given: | | From your webspace provider you will be given: |
| Line 46: |
Line 46: |
|
| |
|
| #This is a one time only exercise but is essential to the operation of your Cumulus website. | | #This is a one time only exercise but is essential to the operation of your Cumulus website. |
| #Configure your [[FTP tool]] to connect to your web server. | | #Configure your [[FTP tools|FTP tool]] to connect to your web server. |
| #Once done, make your connection and change to the correct directory/folder on your site, as advised by your provider. | | #Once done, make your connection and change to the correct directory/folder on your site, as advised by your provider. |
| #You may wish to create a sub-folder to store your weather site, but for this purpose we will assume not. | | #You may wish to create a sub-folder to store your weather site, but for this purpose we will assume not. |
|
| |
|
| Whether you are using Cumulus 1 or Cumulus MX, the first task is to copy everything (see next section for details of exactly what) in the:
| | The first task is to copy everything (see next section for details of exactly what) in the ''cumulus\webfiles'' folder into where you want to store your web site pages, preserving the sub-folder structure. |
| *Cumulus 1: ''Cumulus\webfiles''
| |
| *Cumulus MX: ''CumulusMX\webfiles''
| |
| folder into where you want to store your web site pages, preserving the sub-folder structure. | |
| | |
| == Cumulus 1.x.y webfiles folder ==
| |
| | |
| {{Version badge 1}} Look at the ''Cumulus\webfiles'' folder on your PC.
| |
|
| |
|
| The folders to be uploaded are: | | The folders to be uploaded are: |
| Line 76: |
Line 69: |
| === The transfer process === | | === The transfer process === |
|
| |
|
| If you're using a graphical ftp client like Filezilla (recommended), in the left hand pane just navigate to the ''webfiles'' folder in Cumulus, open it, and you should see the five (Cumulus 1) or four (Cumulus MX) items listed in previous section. | | If you're using a graphical ftp client like Filezilla (recommended), in the left hand pane just navigate to the ''webfiles'' folder in Cumulus, open it, and you should see the five (Cumulus 1) items listed in previous section. |
|
| |
|
| [[File:SiteBefore.png | Left]][[File:SiteAfter.png | Right]] | | [[File:SiteBefore.png | Left]][[File:SiteAfter.png | Right]] |
| Line 82: |
Line 75: |
| Select them all as in left image, and drag them to your web site in the right hand pane. That's the setup done as in right image. | | Select them all as in left image, and drag them to your web site in the right hand pane. That's the setup done as in right image. |
|
| |
|
| == Cumulus MX webfiles folder ==
| |
|
| |
| {{Version badge Mx}} Look at the ''CumulusMX\webfiles'' folder after un-zipping the download on your computer/device.
| |
|
| |
| The folders to be uploaded are:
| |
| *images
| |
| **When you upload this folder, the two files within it:
| |
| *** logoSmall.png (I have not been able to find where this is used, perhaps someone knows and can update this message)
| |
| ***and picture.jpg (this is used for background to standard web pages, you might upload a different image with same name instead)
| |
| ** will also be uploaded
| |
| *js
| |
| **When you upload this folder, the one file within it will also be uploaded
| |
| *lib
| |
| **When you upload this folder, the 3 sub-folders within it will also be uploaded
| |
| **#highstock
| |
| **#*This script library is NOT used since version 3.5.0 (an old version of highstock is downloaded from the '''https://code.highcharts.com/''' Contents Delivery Network for drawing the graphs on the Trends page)
| |
| **#*Prior to that version, the files within this sub-folder were used for drawing the graphs on the trends page
| |
| **#*If you do decide to update highstocks, you will need to edit all 3 lines in '''web/trendsT.htm''' mentioning highcharts and replace the obsolete "8.0" by the version you choose;
| |
| **#jquery
| |
| **#*This contains 2 files: jQuery template, and jQuery version 1.9 minimised code
| |
| **#* This is used for the standard trends web page
| |
| **#*You might think 1.9 is very old (despite the file name saying latest it is obsolete), but the jQuery template does not work with newer jQuery.
| |
| **#*Actually, MX also uses jQuery 1.8.2, an even more obsolete version, for the gauges web page, but that is downloaded from a Contents Delivery Network by that web page.
| |
| **#steelseries
| |
| **#*This subfolder contains 3 further sub-folders containing HTML5 Canvas Steel Series gauges code needed for the gauges web page
| |
| **#*Most of this code is standard from the steel series package described elsewhere in this wiki, but there is a slight tweak for MX to the defaults in the javaScript file.
| |
| **#*Should you subsequently want to update gauges, for this web page, the latest version can always be downloaded at [[SteelSeries_Versions]] within this Wiki.
| |
|
| |
| The file to be uploaded is the same Cascading Style Sheet as for Cumulus 1:
| |
| *weatherstyle.css
| |
|
| |
|
| = Settings required for automatic regular uploads to web server by Cumulus = | | = Settings required for automatic regular uploads to web server by Cumulus = |
| Line 119: |
Line 82: |
| ===Configuration menu; Internet Settings screen; for Cumulus 1=== | | ===Configuration menu; Internet Settings screen; for Cumulus 1=== |
|
| |
|
| {{Version badge 1}} Within Cumulus 1.x.x, click '''Configuration''', ''Internet'' Settings (for Cumulus MX the interface is as described in the MX part of the forum)
| | Within Cumulus 1.x.x, click '''Configuration''', ''Internet'' Settings (for Cumulus MX the interface is as described in the MX part of the forum) |
|
| |
|
| [[File:SimpleInternet-options.png | Left]] | | [[File:SimpleInternet-options.png | Left]] |
| Line 126: |
Line 89: |
| # Click "OK" when you have entered all the values. | | # Click "OK" when you have entered all the values. |
|
| |
|
| ===Admin Interface: Settings menu: Internet Settings page; for Cumulus MX ===
| |
|
| |
| {{Version badge Mx}} In Cumulus MX, the settings screen is different (part of it can be seen [[MX_Administrative_Interface#Internet_Settings|in MX_Administrative_Interface#Internet_Settings article]]).
| |
| #Again, the next section describes what to enter in each section. Note in MX, you need to click on section headings to open up the options to be set within each section
| |
| #Open up '''Web/FTP site''' to enter host, port, protocol, remote directory, username, password, forum, and webcam
| |
| #Scroll down, and Click the '''Save''' button when you have entered all the values.
| |
|
| |
|
| === Information requested on Internet Settings === | | === Information requested on Internet Settings === |
| Line 186: |
Line 143: |
| You have now told Cumulus how to update your web space with the [[Customised_templates#The_Standard_Templates |Standard Cumulus Template]] files and images for the web. | | You have now told Cumulus how to update your web space with the [[Customised_templates#The_Standard_Templates |Standard Cumulus Template]] files and images for the web. |
|
| |
|
| === Admin Interface: Settings Menu: Internet settings: '''Web/FTP settings''' ===
| |
|
| |
| {{Version badge Mx}}[[File:Include graph data files.PNG|right]]
| |
| #Click on this heading to expand settings as per illustration.
| |
| #''Auto update''
| |
| #*Tick this to enable updates to a web server by MX. (Don't tick it if you don't have any web space).
| |
| #''Include standard files''
| |
| #* Standard files are the web page templates in the web folder, each file as a name ending in "T.htm". Tick here if you want those files to be processed by MX and uploaded at standard web interval to the host and directory we have set earlier.
| |
| #''Include graph data files''
| |
| #* These are files with an extension ".json" and MX generates these automatically, storing them in the web folder. Tick here (as arrowed) if you want those files to be processed by MX and uploaded at standard web interval to the host and directory we have set earlier.
| |
| #''Include Moon image file''
| |
| #*We first need to set (later on this same settings page) that MX is to use system drawing to produce "moon.png" in the same web folder from "MoonBaseImage.png" in that folder. The base image is of a full moon, MX uses system drawing to generated a masked version of this image every hour that reflects the current phase of the moon and stores that in "moon.png".
| |
| #*With "moon.png" being generated, we can tick here to include the new image in an upload by FTP every hour.
| |
| #''ActiveFTP mode, FTP rename, Delete before upload''
| |
| #*Please be guided by the tips below these selections on the settings page.
| |
| #''UTF-8 encoding''
| |
| #*Cumulus supports just two encodings, please see [[Webtags#Encoding|Encoding]] section in another article for more information. Here just tick this selection for standard web pages.
| |
| #''FTP logging''
| |
| #*Normally, this is left unticked, but if you want to check MX is uploading (and you use the simple FTP protocol), you can tick this for every FTP transfer to be logged to [[MXDiags]].
| |
| #''Upload interval''
| |
| #*Standard web pages are updated on the hour and every x minutes thereafter, where x is the number you enter here. Most people would choose 10, 15, 20, or 30, here depending how much uploading they want, and how up to date they want the displayed information to be.
| |
| #*As an aside, if you are not using the standard web pages, many [[:Category:User Contributions|third party]] web pages use ajax (don't worry about what that is) to allow some of the web page content to be updated far more frequently than the actual web pages get uploaded.
| |
| #The realtime settings are only needed for the gauges page and settings depend on your MX version, right hand picture is Cumulus MX settings screen)[[File:Cumulus MX realtime settings.png |Right]]
| |
|
| |
| From build 3042, MX automatically uploads the realtimegauges.txt file.
| |
|
| |
| Note that the realtimegaugesT.txt file for MX is slightly different to the one for Cumulus 1, and it is important to use the one supplied with MX for MX.
| |
|
| |
| You have now told Cumulus how to update your web space with the [[Customised_templates#The_Standard_Templates |Standard Cumulus Template]] files for the web.
| |
|
| |
| ===ADDITIONAL INSTRUCTIONS FOR OLDER MX BUILDS:===
| |
|
| |
|
| Prior to build 3042, you also need to specify an extra file in the table for the steel series gauges page to work:[[File:Extra web settings.png | Right]]
| |
| #'Local filenames' column
| |
| #*Enter the path and filename for the realtimegaugesT.txt file where shown by red box. This will normally be web\realtimegaugesT.txt on Windows, and web/realtimegaugesT.txt on other platforms.
| |
| #'Remote filenames' column
| |
| #*The green box shows where you must type the path to where you want the web page to appear (i.e. where the other web pages are uploaded to) ending with the file name '' realtimegauges.txt''. Typically the path will involve specifying the directory you entered on the 'Sites/Options' tab (see the 'Web Site' settings step 3 for that tab above).
| |
| #'Process?' column
| |
| #*Select this (ringed in purple), as ''realtimegaugesT.txt'' contains web tags and needs to be processed to create the remote file.
| |
| #'Realtime?' column
| |
| #*Select this (ringed in purple), only ''if you want the file to be created at whatever interval you have defined for real-time updates'' (see 'web settings' point 7 above for where you did that); otherwise it will be updated on your web site at the normal updating interval.
| |
| # 'FTP?' column
| |
| #*Select this (ringed in purple) if the destination is remote (don't select if the destination is local).
| |
| #'UTF-8?' column
| |
| #*This is irrelevant for this file.
| |
|
| |
|
| == Optional Pseudo Real-Time Data == | | == Optional Pseudo Real-Time Data == |
| Line 256: |
Line 169: |
| #*# Once completed the Cumulus 1 progress display will end with “Logging Out” and you can close the window. | | #*# Once completed the Cumulus 1 progress display will end with “Logging Out” and you can close the window. |
|
| |
|
| Both Cumulus 1.x.y, and Cumulus MX, while running should create the 9 standard web pages in the local 'web' sub-directory, and upload these to the web space by FTP.
| | Cumulus 1.x.y while running should create the 9 standard web pages in the local 'web' sub-directory, and upload these to the web space by FTP. |
| | | |
| *Cumulus 1.x.y should upload by FTP: | | *Cumulus 1.x.y should upload by FTP: |
| Line 263: |
Line 176: |
| **and graphs for 'trends.htm' page (hum.png, humsm.png, intemp.png, intempsm.png, press.png, presssm.png, rain.png, rainsm.png, raind.png, raindsm.png, raint.png, raintsm.png, temp.png tempsm.png, tempm.png, and tempmsm.png; | | **and graphs for 'trends.htm' page (hum.png, humsm.png, intemp.png, intempsm.png, press.png, presssm.png, rain.png, rainsm.png, raind.png, raindsm.png, raint.png, raintsm.png, temp.png tempsm.png, tempm.png, and tempmsm.png; |
| **optionally depending on settings it also uploads solar.png, solarsm.png, sunshine.png, sunshinesm.png, uv.png, and uvsm.png) from the 'web\images' sub-directory to the 'images' folder on your web space. | | **optionally depending on settings it also uploads solar.png, solarsm.png, sunshine.png, sunshinesm.png, uv.png, and uvsm.png) from the 'web\images' sub-directory to the 'images' folder on your web space. |
| *Cumulus MX should upload by FTP a total of 22 files:
| |
| ** a moon image (moon.png)
| |
| **9 standard web pages
| |
| **realtimegauges.txt
| |
| **11 .json files that Cumulus MX creates in the top level directory (that is, the one it's been installed in), for the graphs ("graphconfig.json", "tempdata.json", "pressdata.json", "winddata.json", "wdirdata.json", "humdata.json", "raindata.json", "solardata.json", "dailyrain.json", "sunhours.json", "dailytemp.json").
| |
|
| |
|
|
| |
|
| Apart from the differences in the user interface, and the differences in web pages for 'gauges.htm' and 'trends.htm', both versions of Cumulus generate the same web pages. When looking at the uploaded web pages using a browser, both can be tested in the same way.
| | All these can be tested in the same way. |
| * Open a web browser | | * Open a web browser |
| *# Type in 'your web site' Universal Resource Locator (URL) name, if you were hosting yourself then ''localhost'' is usually recognised. It could be the same as you typed for ''Host Name'', anyway, your provider has probably told you what your web site name is. | | *# Type in 'your web site' Universal Resource Locator (URL) name, if you were hosting yourself then ''localhost'' is usually recognised. It could be the same as you typed for ''Host Name'', anyway, your provider has probably told you what your web site name is. |
