Document customization env vars

README.md

@@ -24,6 +24,7 @@ If you host your project on your Github **and** do not need a UI for your app, t
     - Authenticates with LDAP, easy to modify to another authentication method if needed
 - :sparkles: Store assets on server disk, or Amazon S3 (with minor modifications)
     - Use pretty much any database for persistence, thanks to [Sails](http://sailsjs.org) & [Waterline](http://waterlinejs.org)
+- :sparkles: Code-less [app customization through env variables](docs/customization.md)
 - :sparkles: Simple but powerful download urls (**NOTE:** when no assets are uploaded, server returns `404` by default):
     - `/download/latest`
     - `/download/latest/:platform`
@@ -80,7 +81,7 @@ git rebase upstream/master
 ```
 
 ## Credit
-This project has been built from the Sails.js up by Arek Sredzki, with inspiration from [nuts](https://github.com/GitbookIO/nuts).
+This project has been built from Sails.js up by Arek Sredzki, with inspiration from [nuts](https://github.com/GitbookIO/nuts).
 
 ## License
 [MIT License](LICENSE.md)

docs/README.md

@@ -9,6 +9,7 @@ There are questions that are asked quite often, [check this out before creating
   - [Database setup](database.md)
   - [Admin authentication](authentication.md)
 - [Upload assets](assets.md)
+- [Customization](customization.md)
 - [Available URLs](urls.md)
 - [OS X Auto-Updater](update-osx.md)
 - [Windows Auto-Updater](update-windows.md)

docs/api.md

@@ -8,7 +8,7 @@ This private API is used by the Admin UI & is authenticated through LDAP by defa
 
 #### List versions:
 ```
-GET http://download.myapp.com/api/version
+GET http://download.myapp.com/versions/sorted
 ```
 
 #### Get details about specific version:
@@ -23,5 +23,5 @@ PUT http://download.myapp.com/version/availability/1.1.0_default/1574755200000
 
 #### List channels:
 ```
-GET http://download.myapp.com/api/channel
+GET http://download.myapp.com/channels/sorted
 ```

docs/customization.md

@@ -0,0 +1,10 @@
+# Customization
+Although this project is infinitely customizable through the process of forking the repo and making code changes, users that are satisfied with minimal branding can achieve this through environment variables.
+
+The following environment variables can be set to customize the website:
+ - `WEBSITE_APP_TITLE`: The app name to use throughout the website.
+ - `WEBSITE_TITLE`: The title text to show on the home page and to use as the page title.
+ - `WEBSITE_HOME_CONTENT`: Content to display below the title on the home page.
+ - `WEBSITE_NAV_LOGO`: A url to a logo image that will be shown in place of the default Electron logo.
+
+If you are deploying the app through `docker-compose`, then you can simply adjust these parameters in `docker-compose.yml`.