Klaus is a Python based git repository viewer for viewing local file system repositories.
Klaus is a nice companion web based git source viewer if using iForGit to version control your classic IBM i source physical files in IFS based git repositories. And you don't want to send them to a remote server such as GitHub, GitLab or Bitbucket.
For this use-case we will be viewing repository source changes stored in the IBM IFS file system that may have been committed by iForGit IBM i 5250 Git Client users. (http://www.mobigogo.net/files/docs/iforgit) However any IFS based git repository can be viewed from a browser if listed in the runtime configuration.
Slogan from the Github site: klaus: a simple, easy-to-set-up Git web viewer that Just Works
Github site for Klaus https://github.com/jonashaag/klaus
PyPI Site
https://pypi.org/project/klaus
pip3 command line to install Klaus server
pip3 install klaus
pip3 command line to upgrade Klaus server
pip3 install klaus --upgrade
There is no user security on the web server component by default. However the specified repositories are read-only.
If you need some basic security you will possibly want to implement this with the Gunicorn web server and nginx.
Sample nginx config file listed at bottom of article (https://github.com/richardschoen/howtostuff/blob/master/pythonwebgitvieweribmi.md#links)
See site for already available instructions: https://github.com/jonashaag/klaus
TODO: Gunicorn set up for IBM i.
Make sure all Python 3 and gcc yum packages installed on IBM i via IBM ACS Open Source Package Management and /QOpenSys/pkgs/bin is in SSH search path
# Set path to open source packages
export PATH=/QOpenSys/pkgs/bin:$PATH
# Install all Python 3 packages via yum command (Don't forget the asterisk *)
yum install python3*
# Install gcc compiler
yum install gcc
# Install git
yum install git
# Update Python pip installer (version should go from 9.0.1 to 21.1.1 or later during the process)
pip3 install --upgrade pip
# Install the following Python modules
pip3 install klaus
If you get any errors during install, please note them here by opening an issue.
This example runs the Klaus git server over repositories /gitrepostest/GITTEST123 and /gitrepostest/GITTEST124 on HTTP port 4646 and is listening on all IP addresses.
Running Klaus server on local IBM i and listening on any address (Insecure without nginx)
klaus --host 0.0.0.0 --port 4646 /gitrepostest/GITTEST123 /gitrepostest/GITTEST124
Running Klaus server with nginx. Use localhost/127.0.0.1 since nginx will proxy calls to Klaus
klaus --host 127.0.0.1 --port 4646 /gitrepostest/GITTEST123 /gitrepostest/GITTEST124
This example runs the Klaus git server over repositories GITTEST123 and GITTEST124 on HTTP port 4646 and is listening on all IP addresses.
The background job is submitted via SBMJOB using the QSHEXEC command. (Must install QSHONI library from: http://www.github.com/richardschoen/qshoni)
Running Klaus server on local IBM i and listening on any address. (Insecure without nginx)
SBMJOB CMD(QSHONI/QSHEXEC CMDLINE('klaus --host 0.0.0.0 --port 4646 /gitrepostest/GITTEST123 /gitrepostest/GITTEST124')
SETPKGPATH(*YES) PRTSPLF(GITVIEWER)) JOB(GITVIEWER) JOBQ(QUSRNOMAX) JOBMSGQFL(*WRAP)
Running Klaus server with nginx. Use localhost/127.0.0.1 since nginx will proxy calls to Klaus
SBMJOB CMD(QSHONI/QSHEXEC CMDLINE('klaus --host 127.0.0.1 --port 4646 /gitrepostest/GITTEST123 /gitrepostest/GITTEST124')
SETPKGPATH(*YES) PRTSPLF(GITVIEWER)) JOB(GITVIEWER) JOBQ(QUSRNOMAX) JOBMSGQFL(*WRAP)
Log in from any web browser with the following url and port where sysnameorip is your IBM i host IP address and port is the specified port number.
Example using port 4646:
http://sysnameorip:4646
WRKACTJOB JOB(GITVIEWER)
| ❗ When using nginx to proxy access to the Klaus server, make sure Klaus listens on IP 127.0.0.1 instead of 0.0.0.0 |
|---|
| ❗ You should set up your nginx server to use SSL. This example does not. |
|---|
Sample nginx config file: nginx-klaus.conf
#user nobody;
worker_processes 1;
#error_log logs/error.log;
#error_log logs/error.log notice;
#error_log logs/error.log info;
#pid logs/nginx.pid;
events {
worker_connections 1024;
}
http {
include mime.types;
default_type application/octet-stream;
#log_format main '$remote_addr - $remote_user [$time_local] "$request" '
# '$status $body_bytes_sent "$http_referer" '
# '"$http_user_agent" "$http_x_forwarded_for"';
#access_log logs/access.log main;
sendfile on;
#tcp_nopush on;
#keepalive_timeout 0;
keepalive_timeout 65;
#---------------------------------------------------
# Non SSL Reverse Proxy for Git Viewer
# This example passes the incoming request on port
# 4647 to the nginx server and passes the request
# to internal Klaus Git Viewer localhost address on port 4646
#
# Enable user security
# - Uncomment auth_basic and auth_basic_user_file to enable user auth.
# - .httpasswd file must exist if uncommenting/enabling basic user/password checking.
# - Set up nginx .httpasswd file. See following web link for nginx user/pass setup example
# https://www.digitalocean.com/community/tutorials/how-to-set-up-password-authentication-with-nginx-on-ubuntu-14-04
#---------------------------------------------------
server {
listen 4647;
#auth_basic "Enter Git Viewer User Info";
#auth_basic_user_file /QOpenSys/etc/nginx/.htpasswd;
server_name mygitviewer.com;
location / {
proxy_pass http://localhost:4646;
proxy_pass_request_headers on;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
#proxy_redirect off;
proxy_cookie_domain localhost 127.0.0.1;
proxy_http_version 1.1;
proxy_set_header Connection "";
}
error_page 404 /404.html;
# redirect server error pages to the static page /50x.html
#
error_page 500 502 503 504 /50x.html;
location = /50x.html {
root html;
}
}
}
See the Klaus site for further documentation https://github.com/jonashaag/klaus
Nginx user/password file set up https://www.digitalocean.com/community/tutorials/how-to-set-up-password-authentication-with-nginx-on-ubuntu-14-04