diff options
| author | bill <bill@pixelspoke.com> | 2015-04-29 11:50:57 -0700 | 
|---|---|---|
| committer | bill <bill@pixelspoke.com> | 2015-04-29 11:50:57 -0700 | 
| commit | 6bcad76c1a9216bc98ddb05215c46bf62eb75cf0 (patch) | |
| tree | 7e3d37be626624c358a08fa0ac200813dc4eba49 | |
| parent | f5ad80452b1f6d064c7daa18c679b47fedac9e61 (diff) | |
add clarifactions and better formatting
| -rw-r--r-- | README.md | 60 | 
1 files changed, 31 insertions, 29 deletions
@@ -1,10 +1,10 @@  # weewx-S3upload -Extension to upload web files to an AWS S3 bucket from where they are publicly served. +This is a weewx extension to upload web files to an AWS S3 bucket.  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  +and is costing me around USD 0.50/month. This is cheaper than usual   website hosting and saves me the worry of someone hacking into the  system running weewx. @@ -15,7 +15,8 @@ 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. +website. You'll need to add a DNS record for the URL you choose for +accessing the bucket.  Clone this repo to your weewx extensions directory; for example @@ -27,44 +28,45 @@ git clone git@github.com:wmadill/weewx-S3upload /home/weewx/extensions/weewx-S3u  1. run the installer -``` -cd /home/weewx -setup.py install --extension extensions/weewx-S3upload -``` +  ``` +  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. +2. modify the S3upload stanza in weewx.conf and set your S3 access +code, secret token, and bucket name. You will get those when you set +up the bucket you want to use.  3. restart weewx: -``` -sudo /etc/init.d/weewx stop -sudo /etc/init.d/weewx start -``` +  ``` +  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 -``` +  ``` +  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' -``` +  ``` +  [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 -``` +  ``` +  sudo /etc/init.d/weewx start +  ```  | 
