https://github.com/hacdias/caddy-service

:black_large_square: Run Caddy as a service
https://github.com/hacdias/caddy-service

caddy extension plugin server service

Last synced: about 2 months ago
JSON representation

:black_large_square: Run Caddy as a service

• Host: GitHub
• URL: https://github.com/hacdias/caddy-service
• Owner: hacdias
• License: apache-2.0
• Archived: true
• Created: 2017-01-14T11:45:32.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-07-17T18:33:49.000Z (about 4 years ago)
• Last Synced: 2024-05-19T12:16:01.557Z (4 months ago)
• Topics: caddy, extension, plugin, server, service
• Language: Go
• Homepage: https://caddyserver.com/docs/hook.service
• Size: 30.3 KB
• Stars: 69
• Watchers: 6
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# service - a caddy plugin

> ⚠️ This plugin is no longer maintained, nor is it compatible with Caddy 2+.

[![CircleCI branch](https://img.shields.io/circleci/project/github/hacdias/caddy-service/master.svg?style=flat-square)](https://circleci.com/gh/hacdias/caddy-service)

[![community](https://img.shields.io/badge/community-forum-ff69b4.svg?style=flat-square)](https://forum.caddyserver.com)

This plugin uses [github.com/kardianos/service](https://github.com/kardianos/service) to create services on Caddy. To work, it implements two flags on Caddy executable:

+ ```-name```, which corresponds to the name of the service (default: ```Caddy```).

+ ```-service```, which can be either install, uninstall, start, stop or restart.

Right now, this plugin seems to work well on most systems that kardianos/service supports, which are Windows XP+, Linux/(systemd | Upstart | SysV), and OSX/Launchd.

**This plugin wasn't widely tested. We count on the community to let us know if you find any eventual bugs and tell us what we can do to improve its functionality.**

### Install a Caddy service:

```

caddy -service install -agree -email [email protected] -conf /path/to/Caddyfile [-name optionalServiceName] [-option optionValue]

```

Notes:

1. You **must** set the `-conf` flag to your Caddyfile. Though, usually Caddy works by using the caddyfile in the directory which the caddy executable resides in, which is not necessarily the working directory. However, the service does not load the Caddyfile from the executable directory, and so must be specified using the `-conf` flag.

2. You **must** set the `-agree` flag, which says that you have read and agree to the Let's Encrypt Subscriber Agreement. Any type of automated startup requires this flag.

3. You **must** set the `-email` flag to your email address if not specified for a site in the Caddyfile. This email address will be used for TLS certificate generation.

4. Notice that if you install the service with a name that is not the default's, you will need to specify it everytime you use one of the other commands using the flag `-name`.

5. You can install the service with default Caddy flag values (e.g. -conf MyCaddyfile)

6. On Windows, you'll have to run the install command as an administrator to have access to Windows Services.

### Uninstall a Caddy service:

```

caddy -service uninstall [-name optionalName]

```

### Start a Caddy service:

```

caddy -service start [-name optionalName]

```

### Stop a Caddy service:

```

caddy -service stop [-name optionalName]

```

### Restart a Caddy service:

```

caddy -service restart [-name optionalName]

```