diff options
| -rw-r--r-- | README.adoc | 5 | ||||
| -rw-r--r-- | acid.adoc | 13 |
2 files changed, 14 insertions, 4 deletions
diff --git a/README.adoc b/README.adoc index 5f2e0a5..e194674 100644 --- a/README.adoc +++ b/README.adoc @@ -9,7 +9,7 @@ while the gist of it is actually very simple--run some stuff on new git commits. 'acid' provides a simple web frontend, as well as a webhook endpoint for notifications about new commits. The daemon is supposed to be "firewalled" -by a normal HTTP server, and it will not provide TLS support to secure +by a normal HTTP server, and as such it will not provide TLS support to secure communications. 'acid' runs tasks over SSH, which should be universal enough. @@ -26,6 +26,9 @@ Getting it to work You will need to write your own runner scripts, which may be nontrivial. The author suggests using __cloud-init__-enabled virtual machines with QEMU. +For a step-by-step guide, see +https://p.janouch.name/text/continuous-integration.html[the related article]. + Demo ---- 'acid' is deployed on https://git.janouch.name[]. @@ -15,11 +15,14 @@ Synopsis Description ----------- *acid* run without command arguments will start an HTTP server that creates -and executes tasks upon receiving push notifications from a Gitea instance, -according to the passed configuration file. +and executes tasks against *git*(1) commits from a particular Gitea instance, +in accordance with the passed configuration file. When a command is passed, *acid* will relay it to that running instance -as an RPC call. +of itself as an RPC call. + +Tasks can be triggered to run either upon receiving Gitea push events +on the */push* endpoint, and/or using the RPC commands. Options ------- @@ -85,3 +88,7 @@ Reporting bugs -------------- Use https://git.janouch.name/p/acid to report bugs, request features, or submit pull requests. + +See also +-------- +*git*(1), *sh*(1) |