appd

README

caddy-appd

Service Management App for Caddy v2.

Please ask questions either here or via LinkedIn. I am happy to help you! @greenpau

Please see other plugins:

• caddy-security
• caddy-trace

Table of Contents

• Overview
• Getting Started

Overview

The caddy-appd is a Caddy app that starts and stops non-Caddy applications.

The primary use case is enabling starting the applications proxied by caddy at startup. This way, there is no need to orchestrate the starting of services prior to the starting of caddy itself.

Getting Started

For example, the following configuration starts up webapp1 in /usr/local/www/webapp directory. The app is listening on port 8080. When requests arrive for webapp1.myfiosgateway.com, they are being proxied to webapp1.

{
  appd {
    app webapp1 {
      workdir /usr/local/www/webapp
      cmd /usr/local/bin/webapp
      args foo bar --foo=bar --port=8080
    }
  }
}

webapp1.myfiosgateway.com {
  route {
    reverse_proxy localhost:8080
  }
}

There is a sample config in assets/config/Caddyfile.

Test its configuration:

curl https://localhost:8443/version
curl https://localhost:8443/pytest/foo

Documentation

Index

• type App
  • func (App) CaddyModule() caddy.ModuleInfo
  • func (app *App) Provision(ctx caddy.Context) error
  • func (app App) Start() error
  • func (app App) Stop() error

Types

type App

type App struct {
	Name   string           `json:"-"`
	Config *services.Config `json:"config,omitempty"`
	// contains filtered or unexported fields
}

App implements systemd-like service manager.

func (App) CaddyModule

func (App) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*App) Provision

func (app *App) Provision(ctx caddy.Context) error

Provision sets up the service manager.

func (App) Start

func (app App) Start() error

Start starts the service manager and associated services.

func (App) Stop

func (app App) Stop() error

Stop stops the service manager and associated services.