diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 70 |
1 files changed, 69 insertions, 1 deletions
@@ -1,2 +1,70 @@ # weewx-S3upload -Extension to upload web files to an AWS S3 bucket from where they are publicly served +Extension to upload web files to an AWS S3 bucket from where they are publicly served. + +Rather than serving the web pages generated by weewx directly from a +webserver running on the same system as weewx, I upload those pages +to an AWS S3 bucket. The bucket is configured to be a static website +and is costing me around USD0.50/month. This is cheaper than usual +website hosting and saves me the worry of someone hacking into the +system running weewx. + +## Setup + +Before installing this extensions, get an S3 bucket at Amazon +https://aws.amazon.com/. Sign into the management consule, create an +account if necessary, then create an S3 bucket. + +Search their help pages for how to set up the bucket as a static +website. + +Clone this repo to your weewx extensions directory; for example + +``` +git clone git@github.com:wmadill/weewx-S3upload /home/weewx/extensions/weewx-S3upload +``` + +## Installation instructions: + +1. run the installer + +``` +cd /home/weewx +setup.py install --extension extensions/weewx-S3upload +``` + +2. modify the S3upload stanza in weewx.conf and set your +S3 access code, secret token, and bucket name. + +3. restart weewx: + +``` +sudo /etc/init.d/weewx stop +sudo /etc/init.d/weewx start +``` + +## Manual installation instructions: + +1. copy files to the weewx user directory: + +``` +cp -rp skins/S3upload /home/weewx/skins +cp -rp bin/user/S3upload /home/weewx/bin/user +``` + +2. add the following to weewx.con + +``` +[StdReport] + ... + [[S3upload]] + skin = S3upload + acces_key = 'REPLACE_WITH_YOUR_S3_ACCESS_KEY' + secret_token ='REPLACE_WITH_YOUR_SECRET_TOKEN' + bucket_name = 'REPLACE_WITH_YOUR_S3_BUCKET_NAME' +``` + +3. start weewx + +``` +sudo /etc/init.d/weewx start +``` |