Merge branch 'dev'

Author: Zachary DuBois

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## v0.4
+
+- Moves most tasks into functions.
+- Better output logging.
+- Adds different `runType`s.
+- Changes generation files names and extensions.
+- AWS process conflict now has a variable fail time and sends notifications via Pushover.
+- Adds workflows so you can create a custom setup easily.
+- Adds a separate place for temporary files.
+- Changes a lot of the configuration variables.
+- Adds automatic Elastic Transcoding of media files.
+- Waits for transcoding to fully finish.
+- Fixes and/or logic in the variable check.
+- Adds file type icons to the listing based on extention.
+- More sleek interface made with Bootstrap and Font Awesome.
+
 ### v0.3.1
 
 - Re-Licensed the code correctly this time. Now it is correctly under MIT.
@@ -40,4 +56,3 @@
 ### v0.1
 
 - Initial release.
-

INSTALLATION.md

@@ -1,6 +1,6 @@
 # Installation
 
-*v0.3.1*
+*v0.4*
 
 #### 1)
 
@@ -10,9 +10,18 @@ Install and completely configure the AWS CLI.
 
 Documentation on configuring the AWS CLI can be found [here](http://aws.amazon.com/cli/).
 
+If you need an example AWS config file, you can look in `examples/awsconfig`.
+
 #### 2)
 
-Download Night Uploader and make a place for all of the files in the `templates` directory. Take note of the location.
+Night Uploader needs four directories:
+
+- An upload directory.
+- An dump directory.
+- A template directory.
+- And a temporary files directory.
+
+Make these and take note of the locations. 
 
 #### 3)
 
@@ -24,16 +33,22 @@ Set the file to permissions of `700`.
 
 Open the `night-uploader` file and look at the variables block.
 
-Set `location` to the directory where files will be put for pending upload.
+Set `loc` to the directory where files will be put for pending upload.
 
 Set `s3bucket` to the name of the S3 bucket you would like Night Uploader to upload to.
 
-Set `endLocation` to where the files are moved after the have been uploaded.
+Set `endLoc` to where the files are moved after the have been uploaded.
+
+Set `templateLoc` to where the place where you put the template files that came in the `templates` directory of the download (You were told to take a note of it!). This directory must not be located in the `endLocation` or `location` directories and must be accessible to the script.
+
+Set `temporaryDirLoc` to where you want Night Uploader to put temporary files it generates.
 
-Set `templateLocation` to where the place where you put the template files that came in the `templates` directory of the download (You were told to take a note of it!). This directory must not be located in the `endLocation` or `location` directories and must be accessible to the script.
+Now, you need to upload everything in the `upload/` folder that comes with Night Uploader to your S3 bucket @ `s3://yourbucketname/assets/`. Otherwise, the Index page will not load the required CSS and JS to work.
 
 
-#### 6) [Optional]
+#### 7) [Optional]
+
+##### Pushover
 
 Setup [Pushover](https://pushover.net) support for sending of notifications about uploads and statuses.
 
@@ -47,27 +62,59 @@ Set `pushoverURL` to the URL you want Pushover to have a link for.
 
 Set `pushoverURLTitle` for a title to the URL above.
 
-#### 7) [Optional]
+##### Fail Time
+
+Set `failTime` to how many seconds you want Night Uploader to wait for a running AWS process to complete.
+
+##### Set File Types
 
-Add a cronjob in your crontab to run the script one a day at 3am.
+Preset, there are regular expressions to match file extensions. These can be modified to whatever file types you want.
+
+*Warning: Editing the audio and video types will mess with the `transcodeMedia` function. Make sure you know what AWS ETC supports when editing.*
+
+- `formatVideo`
+- `formatAudio`
+- `formatCode`
+- `formatPDF`
+- `formatImage`
+- `formatArchive`
+
+#### 8) Workflows
+
+By default, when Night Uploader runs, it runs the workflow ID `1`. To make NightUploader run others, you can run Night Uploader by passing an argument for it (In this case, a workflow ID number). Since Night Uploader comes with two handy workflows, you can run `./nightuploader 1` (or `./nightuploader`) to run the first and `./nightuploader 2` to run the second. You can edit how the workflows run by editing the bottom of the Night Uploader script to your liking.
+
+Currently, the following functions work:
+
+- `makeNewFilesList`
+- `uploadFiles`
+- `cleanUp`
+- `moveFiles`
+- `transcodeMedia`
+- `makeIndex`
+
+#### 9) CronJob
+
+Add a cronjob in your crontab to run the script one a day at 3am. Make sure to include a workflow ID if you have a specific one you want it to run.
 
     crontab -e
     0 3 * * * /path/to/night-updater
 
-#### 8)
+#### 10)
 
 Add a test file and let it run over night. Check in the morning to see if it's in S3 and the done folder.
 
 # Customization
 
 If you want to be able to use your own index theme or HTML, you can! Open up the template files and edit away! Just make sure not to change the file names. Below is how these files are loaded by the script.
 
-    head
+    head.html
     [List Items]
-    afterlist
+    afterlist.html
     [Number of files]
     [Timestamp]
     [Project info]
-    footer
+    footer.html
 
 Items in brackets `[]` are added by the script and items not in brackets are added directly from that named template file.
+
+For an easy color or CSS/JS tweak, you can also edit the `assets/night/*` with whatever you want because it is already loaded on the page.

README.md

@@ -1,6 +1,6 @@
 # Night Uploader
 
-*v0.3.1*
+*v0.4*
 
 ## Features
 
@@ -10,6 +10,7 @@
 - Creates an automatic index file that lists everything (minus folders) located in the root of your S3 bucket.
 - Index file is customizable to fit your needs.
 - Checks to see if there is already an instance of AWS running.
+- Automatic use of the ETC (Elastic Transcoder) to render your media into various formats (Follow the `INSTALLATION.md` for setting up the correct pipeline).
 
 ## Requirements
 
@@ -23,3 +24,9 @@
 - Currently running this on my Raspberry Pi to upload files over night so I don't have slow internet during the day or need to leave my computer on over night.
 - I recommend this to be run by a cronjob once a day at 3am. Example in the `INSTALLATION.md`.
 - Recommended file permissions of `700` due to it containing API keys.
+
+## Known Issues
+
+- You currently need to only use filenames containing no special characters or spaces.
+- Filenames cannot contain a dot except for the extension.
+- Notify me of any others right away :)

TODO.md

@@ -0,0 +1,2 @@
+# TODO
+

examples/awsconfig

@@ -0,0 +1,7 @@
+[default]
+output = text
+aws_access_key_id = YOURKEYHERE
+aws_secret_access_key = YOURKEYHERE
+region = us-east-1
+[preview]
+cloudfront = true