GIT-HttpServer

This is a simple HTTP server to provide "NoOps" to the frontend applications. The content must be provided from a git repository.

Every times an application is started, the configured repository is cloned on selected branch (in variable REPO_BRANCH) and can be pulled new version on defined PATH_PULL.

RELEASE NOTES: v0.0.3-alpha

Feature	Description
Done	Add support to proxy redirect with HTTPS backends
Done	Add CodeQL definitions
FIXED	Bump golang.org/x/text from 0.3.7 to 0.3.8
FIXED	Bump github.com/stretchr/testify from 1.7.0 to 1.7.1
FIXED	Bump golang.org/x/sys from 0.0.0-20220209214540-3681064d5158 to 0.1.0
FIXED	Bump golang.org/x/crypto from 0.0.0-20220214200702-86341886e292 to 0.1.0
FIXED	Bump golang.org/x/net from 0.0.0-20220127200216-cd36cc0744dd to 0.17.0 in
FIXED	Vulnerability issue Uncontrolled data used in path Issue
FIXED	Root path issue

Authentication Methods

The GIT-HttpServer only support basic authentication on repositories by protocol HTTPS

Configuration

Environment Variables

Name	Description	Default	Mandatory
PATH_CLONE	Set clone path	_clone	Yes
PATH_PULL	Set pull path	_pull	Yes
PATH_VERSION	Set get git commit version path	_version	Yes
PATH_WEBHOOK	Set webhook path	_hook	Yes
PATH_HEALTH	Set health check path	_health	Yes
REPO_BRANCH	Set default branch to clone content	main	No
REPO_TARGET_FOLDER	Set folder to clone source (only allowed letters, numbers, underscore)	target-git	No
REPO_URL	Set url as a source origin	https://github.com/jarpsimoes/git-http-server.git	No
REPO_USERNAME	Set username or token identifier to basic authentication	N/D	No
REPO_PASSWORD	Set password or token to basic authentication	N/D	No
HTTP_PORT	Set port to expose content	8081	Yes
GHS_CUSTOM_PATH_	Custom path to work as a proxy server	N/D	No
GHS_CUSTOM_REWRITE_	Set to remove from proxy request base path	N/D	No
FOLDER_ROOT (Removed)	The base path will be always root folder of the application	REMOVED	N/D

Implementation

Simple implementation

The most simple implementation of git-http-server

$ docker run \ 
    -p 8081:8081 \
    -e REPO_URL=[URL REPOSITORY] \
    -e REPO_BRANCH=[DEFAULT BRANCH] \
    ghcr.io/jarpsimoes/git_http_server

Test content

$ curl http://localhost:8080

Update Repository

$ curl http://localhost:8080/_pull

Implementation only as a http server (To support angular operator)

$ docker run \ 
    -p 8081:8081 \
    -e REPO_URL="" \
    ghcr.io/jarpsimoes/git_http_server

Implementation with Basic Authentication

The implementation with basic authentication can be used with username and password method, or PAT(Personal Access Token) method (like Gitlab Token). For the PAT approach the username is Token Identifier and Password is token.

$ docker run \ 
    -p 8081:8081 \
    -e REPO_URL=[URL REPOSITORY] \
    -e REPO_BRANCH=[DEFAULT BRANCH] \
    -e REPO_USERNAME=[Token Identifier or Username] \
    -e REPO_PASSWORD=[Password or Token]
    ghcr.io/jarpsimoes/git_http_server

Implementation with Proxy redirect

Git Http Server support routes to redirect for another URL. Should be defined path to redirect and target. The environment variables must be defined as bellow:

• GHS_CUSTOM_PATH_example/path/redirect: "https://example.org"
• GHS_CUSTOM_REWRITE_example/path/redirect: true # If you need remove the "example/path/redirect" from the proxy request must be defined:

$ docker run \ 
    -p 8081:8081 \
    -e REPO_URL=[URL REPOSITORY] \
    -e REPO_BRANCH=[DEFAULT BRANCH] \
    -e REPO_USERNAME=[Token Identifier or Username] \
    -e REPO_PASSWORD=[Password or Token] \
    -e GHS_CUSTOM_PATH_google/redirect=https://www.google.pt
    -e GHS_CUSTOM_REWRITE_google/redirect=true
    ghcr.io/jarpsimoes/git_http_server

Test content

$ curl http://localhost:8080

Update Repository

$ curl http://localhost:8080/_health

Kubernetes implementation

The git-http-server is Kubernetes Ready, can be deployed as simple deployment. See bellow an example of kubernetes deployment.

apiVersion: apps/v1
kind: Deployment
metadata:
  name: simple-content-deployment
spec:
  replicas: 1
  strategy:
    type: RollingUpdate
  selector:
    matchLabels:
      app: git-http-server-example-1
  template:
    metadata:
      labels:
        app: git-http-server-example-1
    spec:
      containers:
        - ports:
            - name: http
              containerPort: 8081
              protocol: TCP
          resources:
            limits: {}
            requests: {}
          env:
            - name: REPO_URL
              value: [REPOSITORY_URL]
          name: git-http-server
          image: ghcr.io/jarpsimoes/git_http_server:v0.0.1-beta
          imagePullPolicy: Always
          livenessProbe:
            httpGet:
              port: 8081
              path: /_health
            failureThreshold: 3
            periodSeconds: 10
          startupProbe:
            httpGet:
              port: 8081
              path: /_health
            failureThreshold: 3
            periodSeconds: 10