Docs
Sandstorm.io »
Using
Overview
Sandstorm as a user: learn to create documents, grant access, and more
Guided tour
Optional: Install Sandstorm
Create a virtual machine in Amazon EC2
Configure the EC2 security groups (firewall) to let you reach Sandstorm
SSH in, and run the Sandstorm install script
Proceed with the guided tour
Hands-on tour
Like Google Apps, but open source and on your own server
Sharing
Static publishing
Ask questions
Top bar
Overview of the bar
Summary of the elements
How it works
HTTP Communication Overview
Security practices
Mitigation of app bugs
Defense against malicious apps
Defense against surveillance and profiling
Security non-events
Background
Etherpad
WordPress
Roundcube
ShareLaTeX
Tiny Tiny RSS
Linux kernel
Developing apps
Developer hub
What makes a good Sandstorm App?
Packaging apps with vagrant-spk
Installing vagrant-spk for package dev
Ensure git is installed
Ensure Vagrant is installed
Ensure VirtualBox is installed
No need to install Sandstorm directly
Install vagrant-spk
Packaging tutorial
Overview of Sandstorm packages
Before proceeding, install vagrant-spk
Packaging tutorial (Meteor)
Introduction
Overview of Sandstorm packages
Prepare the app
Set up for Sandstorm development
Start a virtual machine ready to run Sandstorm and Meteor
Connect your app to your local Sandstorm server
Launch your app with one click
Configure your app's name & other metadata
Create an SPK package file
Clean up
Understanding & customizing vagrant-spk
Overview of vagrant-spk
What the files are for
global-setup.sh
setup.sh
build.sh
launcher.sh
sandstorm-files.list
sandstorm-pkgdef.capnp
Vagrantfile
Example setups
Default setup
Paperwork (php, mysql, composer, npm)
Platform stacks
About platform stacks
DIY platform stack
Meteor platform stack
Code dependencies
Supported by the platform stack
Beyond the platform stack
Service dependencies
MySQL
Other services
Troubleshooting
Debugging a running grain
Other packaging approaches
Raw packaging guide
Prerequisites
Framework-specific tools/guides
Generic steps
Write an app
Create a Sandstorm package definition
Test your app in dev mode
Inspect the file list
Build your package
Publish your app
Tips and Tricks
Accessing external resources
Reproducible builds
Testing updates
Keyrings
Package IDs
What makes a good Sandstorm app?
Raw integration of Python
Integrating with raw Sandstorm APIs
Packaging gotchas
KeyError: 'getpwuid(): uid not found: 1000'
Raw integration of Ruby on Rails
Introduction
Ruby installation
RBenv / Ruby-Build
RVM
Project Setup
Directory Structure
Symlinks
Database Configuration
gems
Ruby PATH
Session Secret
Precompile Assets
Login
Devise
Boot Time
Miscellany
Referer header
Javascript Runtime
Migrations
Raw integration of pure client apps
Caveat: Collaboration
Integrating your app with Sandstorm
User authentication & permissions
Headers that an app receives
URLs, domain names, page titles
Exporting HTTP APIs
Web publishing
Connecting grains to each other & Sandstorm via the powerbox
Email from apps
Note: Provisional API
Overview
Using sandstorm-http-bridge
Receiving
Sending
Using HackSession/HackSessionContext
Receiving through HackSession
Sending with HackSessionContext
App market publishing guide
Administering
Overview
Running Sandstorm on your own server
Administrator's guide
Customizing Sandstorm for your users
File locations & service management
Processes and syscalls: Getting under the hood of Sandstorm
New versions and applying updates
Sandstorm itself
Sandstorm apps
Hostnames and wildcards
Accounts, authentication, and access control
Frequently asked questions
Installation
Installing & uninstalling
Option 1: HTTPS-verified install
Option 2: GitHub-verified install
Option 3: PGP-verified install
Option 4: Installing from Source
Prerequisites
Get the source code
Building / installing the binaries
Hacking on the shell
Hacking on the C++
Running the test suite
Option 5: Integrating with configuration management systems like Ansible/Puppet
Option 6: Using Sandstorm within Docker
Option 7: Use Vagrant when deploying on Mac or Windows
Tips
Uninstall
Troubleshooting a new install
Reference docs for install.sh
Demo mode
Purpose of demo mode
Data deletion
Enabling demo mode
App demos
Backups
To back up one individual grain
To back up the entire Sandstorm server
To restore a Sandstorm server backup
Networking configurations
Wildcard hosts
Sandcats dynamic DNS
HTTPS & SSL
How to get HTTPS on your Sandstorm install
Additional options
Free sandcats.io HTTPS
Enabling HTTPS for an existing sandcats.io Sandstorm server
Technical details
Self-signed SSL
Common problem: Grains don't load
References
Reverse Proxy
nginx optional: Apache2 and other choices available
HTTPS or not: you choose
Create DNS entries
Prerequisites for HTTPS
Configure nginx
Configure Sandstorm's configuration files
Run
Test your Sandstorm install
Sharing the HTTPS Port
Install sniproxy
Setting up sniproxy
Configuration
Startup
Setting up Sandstorm
Setting up your current web server
Final steps: put it to work
Email
Outgoing SMTP
Receiving email into Sandstorm grains
Aside: How to test your configuration
Set up DNS
Configure port 25, the easy way: Sandstorm can listen on port 25
Configure port 25, the advanced way: Proxy SMTP
Running Sandstorm offline
Reference docs for sandstorm.conf
Organizational Features
Defining an organization, and its impact on permissions
Additional organization settings
Authentication provider: SAML 2.0
Authentication provider: LDAP
Whitelabeling
Features coming soon
Active Directory integration
Running a Sandstorm hosting provider
One Sandstorm server per customer
Selling accounts on a Sandstorm server
Selling accounts on a Sandstorm server, plus auto-scaling
Docs
Sandstorm.io »
Docs
»
Search Results
Searching...
GitHub