bbfsserver

module
v0.0.11 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 7, 2024 License: MIT

README

BBFS Server

A simple http server that serves the content of a Bitbucket Server server via HTTP.

This version only supports the Bitbucket Server API, latest.

It uses caching to minimize the load on the Bitbucket server. You need to restart the server to clear the cache.

It has no dedicated probes, but you can use / as startup, liveness and readiness probe.

Usage: bbfsserver
Runs a webserver on top of a bitbucket repos on a Bitbucket Server.

Environment variables
    PORT                        listen port, defaults to 8080
    BBFSSRV_LISTEN_ADDRESS      listen address, this allows you to specify the ip address 
                                to listen on, default to ":8080"
    BBFSSRV_HOST                Bitbucket server host
    BBFSSRV_PROJECT_KEY         Bitbucket project key or user id
    BBFSSRV_REPOSITORY_SLUG     Bitbucket repository name
    BBFSSRV_ACCESS_KEY          Bitbucket http access key for the repo or project
    BBFSSRV_LOG_FORMAT          log format [ text | json], defaults to json
    BBFSSRV_TAG_POLL_INTERVAL   Polling interval, format is what time.ParseDuration accepts,
                                if the input is invalid, then the polling interval is the 
                                default, 5m (5 minutes)
                                Examples: 5 minutes => 5m, 10 seconds => 10s

Used tools

This project uses devbox to install the tools:

  • mage
  • ko
  • crane

It also needs go to be installed. If this is not the case, you can add it to devbox with devbox add go.

Directories

Path Synopsis
cmd
bbfsserver
bbfsserver runs a web server in front of a Bitbucket repository
bbfsserver runs a web server in front of a Bitbucket repository
handlers
Use go to build the artefacts
Use go to build the artefacts

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL