Skip to content

Commit

Permalink
add more to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lia-07 committed Oct 26, 2023
1 parent ec10247 commit ae6d920
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,8 @@ Here are descriptions of the different arguments:
By default, LitePipe looks for `config.json` in the same directory it is in. The configuration file should looks something like this:
If necessary (for example, if LitePipe is running in a `systemctl` environment) you can specify a custom path for the configuration file with the `-config` flag. For example, on a UNIX/UNIX-like system you could run `./litepipe -config "/home/user/litepipe/config.json"`.

## Future goals

I would like to make LitePipe more flexible and add support for different "pipes", i.e. different webhooks/directories affected by commits cause different outcomes. I also want to add support for different types of webhooks, and even support user-defined events for use as a more general purpose automation tool.

After creating the configuration file, you simply need to execute the LitePipe binary. Personally, I set it up behind an Nginx reverse proxy, and haven't tested other configurations.

0 comments on commit ae6d920

Please sign in to comment.