Skip to content

Latest commit

 

History

History
75 lines (63 loc) · 2.44 KB

cli.md

File metadata and controls

75 lines (63 loc) · 2.44 KB
Raw

MyPaas CLI commands

On the client (your work machine)

$ mypaas

usage: mypaas command [arguments]

MyPaas is a tool that makes it easy to run a platform as a service (PaaS)
on your own VM or hardware. It combines Traefik and Docker, enabling free
automatic https (via Let's Encrypt) and deployments via dockerfiles.

This is the client CLI. Use 'mypaas server ..' for server commands.
Commands to run at your work machine:

    version
        Print version.
    help
        Show this help message and exit.
    key_init
        Setup a keypair to authorize this machine to a MyPaas server.
        The private key is stored on this machine and should be kept secret.
        You can also choose to use an existing RSA key.
    key_gen
        Generate (but not store) a generic (passwordless) SSH keypair,
        e.g. to use in CI/CD.
    key_get
        Get the public key corresponding to the private key on this machine.
        This public key can be shared. The key is printed and copied to the
        clipboard.
    push DOMAIN DOCKERFILE
        Push the given dockerfile (or directory containing a Dockerfile)
        to your PaaS, where it will be deployed as an app/service.

On the server

$ mypaas server

usage: mypaas command [arguments]

MyPaas is a tool that makes it easy to run a platform as a service (PaaS)
on your own VM or hardware. It combines Traefik and Docker, enabling free
automatic https (via Let's Encrypt) and deployments via dockerfiles.

Commands to run at the PaaS server:

    version
        Print version.
    help
        Show this help message and exit.
    init
        Initialize the current machine to be a PaaS. You will be asked
        a few questions, so Traefik and the deploy server can be configured
        correctly.
    restart WHAT
        Restart one or all of the MyPaas core processes.
        * all: restart router, stats server, and daemon.
        * daemon: restart the deploy daemon.
        * router: restart the Traefik router, e.g. after editing it's config.
        * stats: restart the stats server.
    deploy DEPLOY_DIR
        Deploy the current directory as a service. The directory must
        contain at least a Dockerfile. In most cases you should probably
        'mypaas push' from your work machine instead.
    schedule_reboot WHEN
        Create a timer+service to reboot the server at a regular interval,
        e.g. every sunday. The default value for when is "Sun 06:00:00".