-
-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1ef2ff2
commit 1478c10
Showing
2 changed files
with
5 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,88 +1,2 @@ | ||
| # Trusted-CGI | ||
| # Initial page | ||
|
|
||
| [](https://github.com/reddec/trusted-cgi) | ||
| [](http://godoc.org/github.com/reddec/trusted-cgi/application) | ||
| [](http://reddec.net/about/#donate) | ||
| [](https://bintray.com/reddec/debian/trusted-cgi/_latestVersion) | ||
|
|
||
|  | ||
|
|
||
| Lightweight self-hosted lambda/applications/cgi/serverless-functions engine. | ||
|
|
||
| [see docs](https://trusted-cgi.reddec.net) | ||
|
|
||
| Features: | ||
|
|
||
| * No specific requirements: just one binary. Working "as-is" | ||
| * One-click new lambda with public link and handler. Available immediately. | ||
| * Rich API | ||
| * Security: user switch, IP restrictions, Origin restrictions, tokens .... | ||
| * Time limits | ||
| * Permanent links (aliases) | ||
| * Actions - independent instruction that could be run via UI/API on server | ||
| * Scheduler: run actions in cron-tab like style | ||
| * ... etc - [see docs](https://trusted-cgi.reddec.net) | ||
|
|
||
| # Installation | ||
|
|
||
| TL;DR; | ||
|
|
||
| * for production for debian servers - use bintray repository (recommend) | ||
| * locally or non-debian server - [download binary](https://github.com/reddec/trusted-cgi/releases) and run | ||
| * for quick tests or for limited production - use docker image (`docker run --rm -p 3434:3434 reddec/trusted-cgi`) | ||
|
|
||
| See [installation manual](https://trusted-cgi.reddec.net/installation) | ||
|
|
||
| # Overview | ||
|
|
||
| The process flow is quite straightforward: one light daemon in background listens for requests and launches scripts/apps | ||
| on demand. An executable shall read standard input (stdin) for request data and write a response to standard output (stdout). | ||
|
|
||
| Technically any script/application that can parse STDIN and write something to STDOUT should be capable of the execution. | ||
|
|
||
| Trusted-cgi designed keeping in mind that input and output data is quite small and contains structured data (json/xml), | ||
| however, there are no restrictions on the platform itself. | ||
|
|
||
| Key differences with classic CGI: | ||
|
|
||
| * Only request body is being piped to scripts input (CGI pipes everything, and application has to parse it by itself - it could be very not trivial and slow (it depends)) | ||
| * Request headers, form fields, and query params are pre-parsed by the platform and can be passed as an environment variable (see mapping) | ||
| * Response headers are pre-defined in manifest | ||
|
|
||
| Due to changes, it's possible to make the simplest script with JSON input and output like this: | ||
|
|
||
| ```python | ||
| import sys | ||
| import json | ||
|
|
||
| request = json.load(sys.stdin) # read and parse request | ||
| response = ['hello', 'world'] # do some logic and make response | ||
| json.dump(response, sys.stdout) # send it to client | ||
| ``` | ||
|
|
||
| Keep in mind, the platform also adds a growing number of new features - see features. | ||
|
|
||
| **target audience** | ||
|
|
||
| It's best (but not limited) for | ||
|
|
||
| * for hobby projects | ||
| * for experiments | ||
| * for projects with a low number of requests: webhooks, scheduled processing, etc.. | ||
| * for a project working on low-end machines: raspberry pi, cheapest VPS, etc.. | ||
|
|
||
| However, if your projects have overgrown the platform limitations, it should be quite easy to migrate to any other solutions, because | ||
| most low-level details are hidden and could be replaced in a few days (basically - just wrap script to HTTP service) | ||
|
|
||
| Also, it is possible to scale the platform performance by just launching the same instances of the platform | ||
| with a shared file system (or docker images) with a balancer in front of it. | ||
|
|
||
|
|
||
| # Contributing | ||
|
|
||
| The platform is quite simple Golang project with Vue + Quasar frontend | ||
| and should be easy for newcomers. Caveats and tips for backend check [here](https://trusted-cgi.reddec.net/development) | ||
|
|
||
| For UI check [sub-repo](https://github.com/reddec/trusted-cgi-ui) | ||
|
|
||
| Any PR (docs, code, styles, features, ...) will be very helpful! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # Table of contents | ||
|
|
||
| * [Initial page](README.md) | ||
|
|