diff options
Diffstat (limited to 'README')
-rw-r--r-- | README | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/README b/README new file mode 100644 index 0000000..47b6038 --- /dev/null +++ b/README @@ -0,0 +1,28 @@ +dscip: Dead Simple Continuous Integration Posix +================================================================================ +Description: +This is a script/daemon that scans a git repo for changes, and runs commands +automatically. It's mean't to be a dead simple alternative to services like +gitlab-ci and jenkins. This script was also made to be as POSIX compliant as +possible, so it should run on basically every platform with a POSIX shell. +================================================================================ +How To Use: + 1. Create a directory somewhere like /var/dscip/project_name. + 2. Copy all the files from dscip into that new directory. + 3. Open dscip in your text editor of choice and modify the variables to your + liking. + 4. Edit pre.sh, build.sh, and post.sh to fit your needs. + 5. Create a user for building. Like `dscip_user` + 6. Run chown -R dscip /var/dscip + So the new user owns it all. + Cron: + Add: * * * * * dscip_user /var/dscip/project_name/dscip + to your crontab. + Daemon: + Set DSCIP_DAEMON to true, and create an init script for it, and enable + it. +================================================================================ +To Do: + - Add chroot capabilities. + - Better daemon-mode capabilities. + - Better how-to instructions... |