You can always have basic help from appflow itself:


Will print a generic help:

% appflow
Type:        AppFlow
String form: <__main__.AppFlow object at 0x7f75a19fa080>
Docstring:   Appflow CLI tool.

Type appflow to have a list of available commands.
Type appflow command -- --help to have help for the specified command.

Usage:      appflow
            appflow add
            appflow checkin
            appflow checkout
            appflow decrypt
            appflow encrypt
            appflow get
            appflow init
            appflow provision
            appflow reset
            appflow rm
            appflow set
            appflow ssh
            appflow status
            appflow tags
            appflow update
            appflow vhosts

You will have greather help, typing appflow COMMAND -- --help This will print a more detailed help for every function you need (add,checking,checkout…)


% appflow provision -- --help                                                    [12:48:37]
Type:        method
String form: <bound method AppFlow.provision of <__main__.AppFlow object at 0x7fc0f056eb70>>
File:        /usr/local/bin/appflow
Line:        197
Docstring:   Provision your machines.
Syntax is:
appflow provision "machine1,machine2" tag1,tag2 skiptag1,skiptag2
tags: will run only the tags specified
skip_tags: will run all the tags except for the specified ones
limit: limit to only some specified hosts.

Optionally it is possible to specify custom tenant and environment
appflow provision tenant-name env-name...
this is optional and by default will read the
default config in ~/.appflow/config.yml

:type  tenant: string
:param tenant: The name of the tenant.

:type  env: string
:param env: The name of the tenant.

:type  limit: string
Usage:       appflow provision [TENANT] [ENV] [LIMIT] [TAGS] [SKIP_TAGS] [FIRSTRUN] [LOCAL]
             appflow provision [--tenant TENANT] [--env ENV] [--limit LIMIT] [--tags TAGS] [--skip-tags SKIP_TAGS] [--firstrun FIRSTRUN] [--local LOCAL]

Read carefully the various helps, and in case of doubts head to the Developer section Where you will be able to read each function’s Docstring and source code.

Let’s Encrypt!

Issue: Setup Let's Encrypt on a server provisioned with Appflow.

Certificate verification:
    ssh REMOTE-SERVER.NAME "sudo cert-verify.sh"

Create a new Certificate:
    ssh REMOTE-SERVER.NAME "sudo cert-create.sh www.YOUR-URL.DOMAIN"

Then manually renew all the certificates:
    ssh REMOTE-SERVER,NAME "sudo cert-renew.sh"


[vagrant] Missing Vagrantfile.local.yml

Issue: There was an error loading a Vagrantfile. The file being loaded
       and the error message are shown below. This is usually caused by
       a syntax error.

       Path: /Users/foo/Documents/webdev/appflow/Vagrantfile
       Line number: 0
       Message: Errno::ENOENT: No such file or directory @ rb_sysopen - Vagrantfile.local.yml`
Solve: add Vagrantfile.local.yml to the appflow folder with this content:

         appflow_folder: "~/Documents/webdev/appflow"
         webdev_folder: "~/Documents/webdev/development"

[vagrant] Vagrant was unable to mount VirtualBox shared folders

Issue: Vagrant was unable to mount VirtualBox shared folders.
       This is usually because the filesystem "vboxsf" is not available.
       This filesystem is made available via the VirtualBox Guest Additions
       and kernel module. Please verify that these guest additions are properly
       installed in the guest. This is not a bug in Vagrant and is usually
       caused by a faulty Vagrant box. For context, the command attempted was:

       id -u deploy

       The error output from the command was:

       id: deploy: no such user
Solve: appflow provision limit=atlantis firstrun=true (password is vagrant).

[vagrant] The box you attempted to add doesn’t match the provider you specified

Issue: The box you attempted to add doesn't match the provider you specified.
Solve: vagrant up --provider=virtualbox atlantis

[vagrant] Lost Vagrant reference to VirtualBox VM

Issue: Lost Vagrant reference to VirtualBox VM

VBoxManage list vms
  "vagrant-atlantis" {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx}
echo xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx > ~/appflow/.vagrant/machines/atlantis/virtualbox/id

[vagrant] Warning: Authentication failure. Retrying…

Issue: vagrant Warning: Authentication failure. Retrying...
Solve: http://stackoverflow.com/a/30792296

[vagrant] an error occurred while downloading the remote file

Issue: An error occurred while downloading the remote file.
       The error message, if any, is reproduced below. Please fix this error and try again.
Solve: sudo mv /opt/vagrant/embedded/bin/curl /tmp

See also: https://github.com/mitchellh/vagrant/issues/7997

[boot] An error occurred while mounting /

Issue: An error occurred while mounting /.
Keys: Press S to skip mounting or M for manual recovery
Press S and try to see if atlantis boots up.
ssh atlantis
mount -o remount,rw / (optional)
e2fsck /dev/sda1