Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kak-tus/essi
Essi - automated perl to deb converter
https://github.com/kak-tus/essi
deb-converter debian-packages perl
Last synced: 6 days ago
JSON representation
Essi - automated perl to deb converter
- Host: GitHub
- URL: https://github.com/kak-tus/essi
- Owner: kak-tus
- License: mit
- Created: 2016-08-16T23:34:50.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-07-28T18:51:18.000Z (over 7 years ago)
- Last Synced: 2024-11-19T16:57:20.160Z (2 months ago)
- Topics: deb-converter, debian-packages, perl
- Language: Perl
- Size: 25.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: Changes
- License: LICENSE
Awesome Lists containing this project
README
# Essi - automated perl to deb converter
Essi based on [dh-make-perl](https://metacpan.org/pod/DhMakePerl).
Essi is a web service with HTTP api (github/gitlab/custom webhooks notification suport) that get some notification
with repo name, download it and creates deb package.
Essi is a part of CI.
## Installation
Best way to use Essi - docker image [kaktuss/essi](https://hub.docker.com/r/kaktuss/essi/).
If you want to start it in usual environment - you must install it
```
cpanm -S https://github.com/kak-tus/Essi.git
```
and start it
```
sudo hypnotoad /usr/local/bin/essi.pl
```
## Github/gitlab/gogs webhooks API
### With clone support thru http
```
http://example-domain:9007/v2/build/github.json
http://example-domain:9007/v2/build/gitlab.json
http://example-domain:9007/v2/build/gogs.json
```
### With clone support thru ssh
```
http://example-domain:9007/v2/build/github-ssh.json
http://example-domain:9007/v2/build/gitlab-ssh.json
http://example-domain:9007/v2/build/gogs-ssh.json
```
If you want to use ssh clone support, you must:
1. Add ssh keys to user with no passphrase to ~/.ssh folder.
2. Add ssh config file to ~/.ssh folder
Example
```
#/home/www-data/.ssh/config
Host git.example.com
IdentityFile /home/www-data/.ssh/git.example.com
User git
Port 10022
```
3. Add yours servers to ~/.ssh/known_hosts file manually or using API method ssh-keyscan.
## Custom API
POST request
```
http://example-domain:9007/v2/build/custom.json
```
with parameter
```
repo=https://github.com/kak-tus/Essi.git
```
Curl example
```
curl -X POST 'http://example-domain:9007/v2/build/custom.json?repo=https://github.com/kak-tus/Essi.git'
```
## File API
Allow to download tar.gz file from cpan (or any other storage) and build it.
POST request
```
http://example-domain:9007/v2/build/file.json
```
with parameter
```
url=https://cpan.metacpan.org/authors/id/K/KA/KAKTUS/Geo-SypexGeo-0.6.tar.gz
```
Curl example
```
curl -X POST 'http://example-domain:9007/v2/build/file.json?url=https://cpan.metacpan.org/authors/id/K/KA/KAKTUS/Geo-SypexGeo-0.6.tar.gz'
```
## ssh-keyscan
When using Essi with ssh clone support you must add yours servers to ~/.ssh/known_hosts file. You can do it manually or using this API method.
POST request
```
http://example-domain:9007/v2/build/ssh-keyscan.json
```
with parameters
```
host=git.example.com (required)
port=10022 (optional, default 22)
```
Curl example
```
curl -X POST 'http://example-domain:9007/v2/build/ssh-keyscan.json?host=git.example.com&port=10022'
```
## Essi with nginx
You can use Essi directly, but the better solution in non-private environment: use nginx (+https) and proxy pass to application like
```
https://example-domain/essi/
```
to
```
http://127.0.0.1:9007/
```