radsoulbeard/smashing repository overview

⁠smashing

Run smashing⁠ in a Docker⁠ container.

Originated from: frvi/dashing⁠

Link: visibilityspots/smashing⁠

⁠Run

docker run -d -p 8080:3030 visibilityspots/smashing

And point your browser to http://localhost:8080/⁠.

⁠Configuration

⁠Custom smashing port

If you want smashing to use a custom port inside the container, e g 8080, use the environment variable $PORT:

docker run -d -e PORT=8080 -p 80:8080 visibilityspots/smashing

⁠Dashboards

To provide a custom dashboard, use container volume /dashboards:

docker run -v=/my/custom/dashboards:/dashboards -d -p 8080:3030 visibilityspots/smashing

(Don't forget to also provide the layout.erb)

⁠Jobs

To provide custom jobs, use container volume /jobs:

docker run -v=/my/cool/job:/jobs -d -p 8080:3030 visibilityspots/smashing

⁠Widgets

To install custom widgets supply the gist IDs of the widgets as an environment variable:

docker run -d -e WIDGETS=5641535 -p 8080:3030 visibilityspots/smashing

This example will install the Random Aww⁠ widget before starting smashing. Multiple widgets can be supplied.

Also you can use local custom widgets

docker run -v=/my/cool/widgets:/widgets -d -p 8080:3030 visibilityspots/smashing

⁠Gems

To install gems, supply the gem name(s) as an environment variable:

docker run -d -e GEMS=instagram -e WIDGETS=5278790 -p 8080:3030 visibilityspots/smashing

This example installs the Instagram photos by location⁠ widget, which depends on the instagram gem. Multiple gems and widgets can be supplied like so:

docker run -d -e GEMS="mysql instagram" -e WIDGETS=5278790 -p 8080:3030 visibilityspots/smashing

⁠Public (favicon, 404)

To provide custom 404 and favicon, use container volume /public.

⁠Configuration File

The configuration file config.ru is available on volume /config.

Edit this file to change your API key, to add authentication and more.

⁠lib volume

The smashing lib dir is available on volume /lib-smashing.

⁠Thanks

• @mattgruter⁠, awsome contributions!
• @rowanu⁠, Hotness Widget⁠.
• @munkius⁠, fork⁠ of Hotness Widget.
• @chelsea⁠, Random Aww⁠.

⁠TODO:

• Use official Ruby image from Docker hub. (Thank you @bemehow⁠)

⁠License

Distributed under the MIT license