sandstorm-io/vagrant-spk

Name: vagrant-spk

Owner: Sandstorm.io

Description: Packaging tool for Sandstorm

Created: 2015-03-09 01:31:43.0

Updated: 2018-05-17 18:04:08.0

Pushed: 2018-05-23 03:29:03.0

Homepage:

Size: 676

Language: Python

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

vagrant-spk

vagrant-spk is a tool designed to help app developers package apps for Sandstorm.

See also https://docs.sandstorm.io/en/latest/vagrant-spk/design/ for more details.

Example usage:

git clone git://github.com/sandstorm-io/vagrant-spk
git clone git://github.com/sandstorm-io/php-app-to-package-for-sandstorm
export PATH=$(pwd)/vagrant-spk:$PATH
cd php-app-to-package-for-sandstorm
vagrant-spk setupvm lemp
vagrant-spk vm up
vagrant-spk init
# edit .sandstorm/sandstorm-pkgdef.capnp in your editor of choice
vagrant-spk dev
# visit http://local.sandstorm.io:6080 in a web browser
# log in as Alice, the admin account
# launch an instance of the example app, play around with it
# then, press Ctrl-C to stop the tracing vagrant-spk dev
vagrant-spk pack example.spk
# You now have an .spk file.  Yay!
# Verify it works by going to http://local.sandstorm.io:6080,
# select "My Files" -> "Upload an app", select your .spk file,
# upload it, install it, and create a new instance of your app.

What the files are for

vagrant-spk will create a .sandstorm/ folder in your repo and set up some files with some defaults for your app stack. You will likely need to modify some of these to adapt their behavior to make the most sense for your app.

See the vagrant-spk docs on customizing your package for full details.

Example apps

See the example app listing in the vagrant-spk documentation.