Skip to content
This repository has been archived by the owner on Mar 20, 2023. It is now read-only.

Commit

Permalink
Add 'We are Closed' comment
Browse files Browse the repository at this point in the history
  • Loading branch information
jung-kurt committed May 30, 2020
1 parent fb22641 commit 71446dc
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 4 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,28 @@
# CGI for Caddy

[![No Maintenance
Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)
[![MIT
licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/jung-kurt/caddy-cgi/master/LICENSE)
[![Report](https://goreportcard.com/badge/github.com/jung-kurt/caddy-cgi)](https://goreportcard.com/report/github.com/jung-kurt/caddy-cgi)

Package cgi implements the common gateway interface
([CGI](https://en.wikipedia.org/wiki/Common_Gateway_Interface)) for
[Caddy](https://caddyserver.com/), a modern, full-featured, easy-to-use
web server.
[Caddy 1](https://caddyserver.com/), a modern, full-featured,
easy-to-use web server.

## We Are Closed

This CGI plugin works with version 1 of the Caddy web server. As of
2020, this version has been superseded by version 2. Circumstances
prevent me from porting this plugin to version 2 and then maintaining
it. However, this is a very simple plugin as the Go standard library
does all of the real work. The bulk of the code is spent parsing the
configuration file and I believe this has been greatly simplified for
version 2. Porting this software to the new version of the Caddy web
server is a good first-time contributor project.

## Documentation

This plugin lets you generate dynamic content on your website by means
of command line scripts. To collect information about the inbound HTTP
Expand Down
17 changes: 16 additions & 1 deletion doc.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,22 @@
/*
Package cgi implements the common gateway interface (CGI) for Caddy, a
Package cgi implements the common gateway interface (CGI) for Caddy 1, a
modern, full-featured, easy-to-use web server.
We Are Closed
This CGI plugin works with version 1 of the Caddy web server. As of
2020, this version has been superseded by version 2. Circumstances
prevent me from porting this plugin to version 2 and then maintaining
it. However, this is a very simple plugin as the Go standard library
does all of the real work. The bulk of the code is spent parsing the
configuration file and I believe this has been greatly simplified for
version 2. Porting this software to the new version of the Caddy web
server is a good first-time contributor project.
Documentation
This plugin lets you generate dynamic content on your website by means
of command line scripts. To collect information about the inbound HTTP
request, your script examines certain environment variables such as
Expand Down
16 changes: 15 additions & 1 deletion doc/document.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
# CGI for Caddy

[![No Maintenance Intended](http://unmaintained.tech/badge.svg)][unmaintained]
[![MIT licensed][badge-mit]][license]
[![Report][badge-report]][report]

Package cgi implements the common gateway interface ([CGI][cgi-wiki]) for
[Caddy][caddy], a modern, full-featured, easy-to-use web server.
[Caddy 1][caddy], a modern, full-featured, easy-to-use web server.

## We Are Closed

This CGI plugin works with version 1 of the Caddy web server. As of 2020, this
version has been superseded by version 2. Circumstances prevent me from porting
this plugin to version 2 and then maintaining it. However, this is a very
simple plugin as the Go standard library does all of the real work. The bulk of
the code is spent parsing the configuration file and I believe this has been
greatly simplified for version 2. Porting this software to the new version of
the Caddy web server is a good first-time contributor project.

## Documentation

This plugin lets you generate dynamic content on your website by means of
command line scripts. To collect information about the inbound HTTP request,
Expand Down Expand Up @@ -654,3 +667,4 @@ cgi /sample/*.php /usr/local/cgi-bin/phpwrap /usr/local/cgi-bin{match}
[report]: https://goreportcard.com/report/github.com/jung-kurt/caddy-cgi
[subkey]: class:subkey
[travis]: https://travis-ci.org/jung-kurt/caddy-cgi
[unmaintained]: http://unmaintained.tech/

0 comments on commit 71446dc

Please sign in to comment.