Merge pull request #3661 from sandstorm-io/vagrant-spk-docs-update
Docs: vagrant-spk update pass
This commit is contained in:
6 files changed
+12
-13
No files matched your search
@@ -110,9 +110,9 @@ ImportError: No such module requests
|
||||
**How to fix the problem:** Our recommendations are as follows.
|
||||
|
||||
- For Python apps, **add the app's virtualenv to alwaysInclude.** To do that, look for the
|
||||
`alwaysInclude` list and add `opt/app/env`. See the [ContactOtter sandstorm-pkgdef.capnp for an
|
||||
`alwaysInclude` list and add `opt/app-venv`. See the [ContactOtter sandstorm-pkgdef.capnp for an
|
||||
example.](https://github.com/phildini/logtacts/blob/27ac05f88896778baf5da155afa6c733d3d6a264/.sandstorm/sandstorm-pkgdef.capnp#L137)
|
||||
It is sometimes helpful to also add `usr/lib/python2.7` (or the corresponding path for your
|
||||
It is sometimes helpful to also add `usr/lib/python3.9` (or the corresponding path for your
|
||||
version of Python).
|
||||
|
||||
- For nodejs apps, **add node_modules to alwaysInclude.** See the [Duolodo sandstorm-pkgdef.capnp
|
||||
|
||||
@@ -10,9 +10,8 @@ downloading dependencies, like the Meteor stack or the Python stack,
|
||||
then you can expect `vagrant-spk` to handle downloading and installing
|
||||
these dependencies for you. Specifically:
|
||||
|
||||
* The `uwsgi` stack creates a virtualenv in the `env` directory within
|
||||
the app's code directory (`/opt/app/env` inside Vagrant) and, if a
|
||||
`requirements.txt` is present, does `pip install -r requirements.txt'
|
||||
* The `uwsgi` stack creates a virtualenv in the `/opt/app-venv` directory and,
|
||||
if a `requirements.txt` is present, does `pip install -r requirements.txt'
|
||||
into the virtualenv.
|
||||
|
||||
* The `meteor` stack uses the `meteor build` process to create a
|
||||
|
||||
@@ -94,7 +94,7 @@ Other things you probably want to do in this script include:
|
||||
|
||||
- Building folder structures in `/var`. `/var` is the only non-tmpfs folder mounted R/W, and when a grain is first launched, it will start out empty. It will persist between runs of the same grain, but be unique per app instance.
|
||||
- Preparing a database and running migrations. You can also manually generate some tables once, place them somewhere under `/opt/app`, and copy them to `/var/lib/mysql` if your app takes a while to do migrations, at the potential cost of producing a larger `.spk`.
|
||||
- Launching other daemons that your app uses (`mysqld`, `redis-server`, `php5-fpm`, `uwsgi`, etc.)
|
||||
- Launching other daemons that your app uses (`mysqld`, `redis-server`, `php-fpm`, `uwsgi`, etc.)
|
||||
|
||||
For apps which need the ability to self-modify code or configuration, or which
|
||||
expect to be able to write data underneath their source tree, you
|
||||
@@ -139,7 +139,7 @@ See [packaging tutorial](packaging-tutorial.md) for details.
|
||||
|
||||
### Default setup
|
||||
|
||||
Repo: [https://github.com/paulproteus/php-app-to-package-for-sandstorm](https://github.com/paulproteus/php-app-to-package-for-sandstorm)
|
||||
Repo: [https://github.com/sandstorm-io/php-app-to-package-for-sandstorm](https://github.com/sandstorm-io/php-app-to-package-for-sandstorm)
|
||||
|
||||
This example shows how to setup a php + mysql app.
|
||||
|
||||
@@ -151,8 +151,8 @@ in the Sandstorm sandbox.
|
||||
dependencies.
|
||||
|
||||
`launcher.sh` creates a folder structure in `/var` for MySQL, nginx, and
|
||||
php5-fpm, creates MySQL tables, then launches the three daemons, checking that
|
||||
`mysqld` and `php7.0-fpm` are ready to accept requests before launching `nginx`,
|
||||
php-fpm, creates MySQL tables, then launches the three daemons, checking that
|
||||
`mysqld` and `php-fpm` are ready to accept requests before launching `nginx`,
|
||||
which will listen for requests on port 8000.
|
||||
|
||||
### Paperwork (php, mysql, composer, npm)
|
||||
|
||||
@@ -136,7 +136,7 @@ Linux virtual machine.
|
||||
|
||||
- Visit the [vagrant-spk releases list](https://github.com/sandstorm-io/vagrant-spk/releases).
|
||||
|
||||
- Download and run the latest EXE file, whose name is typically `vagrant-spk-setup-v0.nnn.exe`. You
|
||||
- Download and run the latest EXE file, whose name is typically `vagrant-spk-setup-v1.n.exe`. You
|
||||
may need administrator privileges to successfully run the installer. This will result in a
|
||||
`vagrant-spk` executable on your system path.
|
||||
|
||||
|
||||
@@ -78,7 +78,7 @@ This tutorial uses a sample PHP web app. To download it, run the following comma
|
||||
|
||||
```bash
|
||||
cd ~/projects
|
||||
git clone git://github.com/paulproteus/php-app-to-package-for-sandstorm
|
||||
git clone git://github.com/sandstorm-io/php-app-to-package-for-sandstorm
|
||||
```
|
||||
|
||||
The app's code will be stored at
|
||||
@@ -144,7 +144,7 @@ we're working on tidying up the scripts to minimize the noise.
|
||||
Eventually, you will see this mesage:
|
||||
|
||||
```bash
|
||||
==> default: Vanilla Debian box. See https://app.vagrantup.com/debian for help and bug reports
|
||||
==> default: Your virtual server is running at: http://local.sandstorm.io:6090
|
||||
```
|
||||
|
||||
and get your shell back. At this point, you can continue to the next step.
|
||||
|
||||
@@ -12,7 +12,7 @@ The following stacks exist:
|
||||
* `lemp`: a PHP-oriented software collection including nginx, MySQL, and PHP.
|
||||
* `lesp`: a similar take on the PHP stack using SQLite as the database.
|
||||
* `meteor`: a stack for [Meteor](https://meteor.com) apps, including MongoDB.
|
||||
* `node`: a Node stack on version 10.x, for modern Node apps.
|
||||
* `node`: a Node stack using the current LTS release, for modern Node apps.
|
||||
* `node6`: a Node stack on version 6.x, for legacy Node apps.
|
||||
* `static`: `nginx` configured to serve static files from `/opt/app`.
|
||||
* `uwsgi`: a Python-oriented stack including nginx and uwsgi.
|
||||
|
||||
Reference in new issue
Block a user