json-rpc-shell/README.adoc

66 lines
2.4 KiB
Plaintext
Raw Normal View History

acid
====
2015-09-27 02:11:38 +02:00
'acid' is A Continuous Integration Daemon. Currently under heavy development.
Right now I'm working on a demo JSON-RPC server that will serve as the basis for
the final daemon.
The aim of this project is to provide a dumbed-down alternative to Travis CI.
I find it way too complex to set up and run in a local setting, while the basic
gist of it is actually very simple -- run some stuff on new git commits.
2015-09-27 02:11:38 +02:00
'acid' will provide a JSON-RPC 2.0 service for frontends over FastCGI, SCGI, or
WebSockets, as well as a webhook endpoint for notifications about new commits.
2015-03-09 23:32:01 +01:00
The daemon is supposed to be "firewalled" by a normal HTTP server and it will
not provide TLS support to secure the communications.
2015-09-27 02:11:38 +02:00
'acid' will be able to tell you about build results via e-mail and/or IRC.
Builds will only be supported on the same machine as the daemon. Eventually I
might be able to add support for fully replicable builds using Docker.
With this being my own project, of course it is written in event-looped C99
where everything is stuffed into just a few files. At least I hope it's written
in a somewhat clean manner. Feel free to contribute.
Building and Installing
-----------------------
Build dependencies: CMake, pkg-config, help2man, libmagic,
2015-09-27 02:11:38 +02:00
liberty (included), http-parser (included) +
Runtime dependencies: libev, Jansson
2015-09-27 02:10:19 +02:00
$ git clone --recursive https://github.com/pjanouch/acid.git
$ mkdir acid/build
$ cd acid/build
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug
$ make
To install the application, you can do either the usual:
2015-09-27 02:11:38 +02:00
# make install
Or you can try telling CMake to make a package for you. For Debian it is:
2015-09-27 02:11:38 +02:00
$ cpack -G DEB
# dpkg -i acid-*.deb
2015-09-27 02:11:38 +02:00
Note that for versions of CMake before 2.8.9, you need to prefix `cpack` with
`fakeroot` or file ownership will end up wrong.
Usage
-----
TODO. The main application hasn't been written yet.
2015-05-07 20:28:24 +02:00
Contributing and Support
------------------------
Use this project's GitHub to report any bugs, request features, or submit pull
requests. If you want to discuss this project, or maybe just hang out with
2016-03-14 21:18:27 +01:00
the developer, feel free to join me at irc://irc.janouch.name, channel #dev.
2015-05-07 20:28:24 +02:00
2017-06-20 14:01:10 +02:00
Bitcoin donations: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9
License
-------
This software is released under the terms of the 0BSD license, the text of which
is included within the package along with the list of authors.