This project is teaching how to build containerized qpkg

Step 0 Ready build containerized qpkg Environment
Step 1 Download Sample Code
Step 2 Ready Build QPKG Environment Dockerfile
step 3 create docker-compose.yml
Step 4 Edit qpkg Configuration Start-Stop Script
Step 5 Generate QPKG File
reference

Step 0 Ready build containerized qpkg Environment

Install Docker Engine
Install Git
It is easiest to install Git on Linux using the preferred package manager of your Linux distribution.
```
$ sudo apt-get install git
```
For other Linux distribution, please refer to Download for Linux and Unix.

Step 1 Download Sample Code

Generate qpkg project

 $ git clone https://github.com/qnap-dev/containerized-qpkg.git

Step 2 Ready Build QPKG Environment Dockerfile

Build QPKG environment Dockerfile

ref:https://docs.docker.com/engine/reference/builder/

FROM ubuntu:20.04

ARG DOCKER_VER=20.10.7

# Install build essentail tools
RUN \
  apt-get update \
  && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
     curl wget fakeroot rsync pv bsdmainutils ca-certificates openssl xz-utils make python2 \
  && rm -rf /var/cache/debconf/* /var/lib/apt/lists/* /var/log/*

# Install qdk2
RUN \
  wget https://github.com/qnap-dev/qdk2/releases/download/v${QDK2_VER}/qdk2_${QDK2_VER}.bionic_amd64.deb \
  && dpkg -i --force-depends qdk2_${QDK2_VER}.bionic_amd64.deb \
  && rm -f qdk2_${QDK2_VER}.bionic_amd64.deb

  && ./InstallToUbuntu.sh install

# Install docker client
RUN \
  curl -sq https://download.docker.com/linux/static/stable/x86_64/docker-$DOCKER_VER.tgz \
  | tar zxf - -C /usr/bin docker/docker --strip-components=1 \
  && chown root:root /usr/bin/docker

WORKDIR /work

step 3 Create docker-compose.yml

Create docker-compose.yml

ref:https://docs.docker.com/compose/

version: '3.1'

services:

  wordpress:
    image: wordpress:5.7.2
    restart: always
    ports:
      - 65000:80
    environment:
      WORDPRESS_DB_HOST: db
      WORDPRESS_DB_USER: exampleuser
      WORDPRESS_DB_PASSWORD: examplepass
      WORDPRESS_DB_NAME: exampledb
    volumes:
      - ${PWD}/data/wordpress:/var/www/html

  db:
    image: mysql:5.7
    restart: always
    environment:
      MYSQL_DATABASE: exampledb
      MYSQL_USER: exampleuser
      MYSQL_PASSWORD: examplepass
      MYSQL_RANDOM_ROOT_PASSWORD: '1'
    volumes:
      - ${PWD}/data/db:/var/lib/mysql

Move docker-compose.yml to qpkg arch file
```
 $ mv docker-compose.yml ./x86_64
```

Step 4 Edit qpkg install Script(package_routines) and Start-Stop Script

Edit package_routines
ref: https://edhongcy.gitbooks.io/qdk-qpkg-development-kit/content/package-specific-installation-functions.html

######################################################################
# Define any package specific operations that shall be performed when
# the package is installed.
######################################################################  
pkg_pre_install(){
  err_log() {
    local write_msg="$CMD_LOG_TOOL -t2 -uSystem -p127.0.0.1 -mlocalhost -a"
    [ -n "$1" ] && $CMD_ECHO "$1" && $write_msg "$1"
  }

  # Official QPKG will enable it when installed
  SYS_QPKG_SERVICE_ENABLED="TRUE"
  result=$(/usr/sbin/lsof -i :65000)
  if [ -n "$result"  ] ;then
    err_log "[App Center] WordPress installation failed. Port 65000 occupied"
    set_progress_fail
    exit 1
  fi
}
#
#pkg_install(){
#}
#
#pkg_post_install(){
#}

Edit start-stop.sh

#!/bin/sh

# change to persistent folder (otherwise in /share/CACHEDEV1_DATA/.qpkg/.tmp)
cd /tmp

# QPKG Information
QPKG_NAME="WordPress"
QPKG_CONF=/etc/config/qpkg.conf
QPKG_DIR=$(/sbin/getcfg $QPKG_NAME Install_Path -f $QPKG_CONF)
QCS_NAME="container-station"
QCS_QPKG_DIR=$(/sbin/getcfg $QCS_NAME Install_Path -f $QPKG_CONF)
QPKG_PROXY_FILE=/etc/container-proxy.d/$QPKG_NAME
DOCKER_IMAGES=$(cat $QPKG_DIR/docker-images/DOCKER_IMAGES)

DOCKER_CMD=$QCS_QPKG_DIR/bin/system-docker
COMPOSE_CMD=$QCS_QPKG_DIR/bin/system-docker-compose

load_image() {
  for docker_image in $DOCKER_IMAGES; do
    # check if image exist
    STATUS=$(curl -siL http://127.0.0.1:2375/images/$docker_image/json | grep HTTP)
    if [[ ! $STATUS == *"200"* ]]; then
      cat $QPKG_DIR/docker-images/$(echo $docker_image | sed -e 's?/?-?' -e 's?:?_?').tar | $DOCKER_CMD load
    fi
  done
}

proxy_reload() {
  /etc/init.d/thttpd.sh reload
  /etc/init.d/stunnel.sh reload
}

proxy_start() {
  cat > $QPKG_PROXY_FILE << EOF
ProxyRequests off
ProxyPass /wordpress http://127.0.0.1:65000
ProxyPassReverse /wordpress http://127.0.0.1:65000
EOF
  proxy_reload
}

proxy_stop() {
  rm -f $QPKG_PROXY_FILE
  proxy_reload
}

cd $QPKG_DIR

case "$1" in
  start)
    ENABLED=$(/sbin/getcfg $QPKG_NAME Enable -u -d FALSE -f $QPKG_CONF)
    if [ "$ENABLED" != "TRUE" ]; then
      echo "$QPKG_NAME is disabled."
      exit 1
    fi

    load_image
    $COMPOSE_CMD up -d
    proxy_start
    ;;
  stop)
    proxy_stop
    $COMPOSE_CMD down --remove-orphans
    ;;
  restart)
    $0 stop
    $0 start
    ;;
  remove)
    $COMPOSE_CMD down --rmi all -v
    ;;
  *)
    echo "Usage: $0 {start|stop|restart}"
    exit 1
esac

exit 0

Edit qpkg.cfg
ref: https://edhongcy.gitbooks.io/qdk-qpkg-development-kit/content/qpkg-configuration-file.html

# Name of the packaged application.
QPKG_NAME="WordPress"
# Name of the display application.
QPKG_DISPLAY_NAME="WordPress"
# Version of the packaged application. 
QPKG_VER="5.7.2"
# Author or maintainer of the package
QPKG_AUTHOR="WordPress"
# License for the packaged application
QPKG_LICENSE="AGPL"
# One-line description of the packaged application
#QPKG_SUMMARY=""

# Preferred number in start/stop sequence.
QPKG_RC_NUM="199"
# Init-script used to control the start and stop of the installed application.
QPKG_SERVICE_PROGRAM="start-stop.sh"

# Specifies any packages required for the current package to operate.
QPKG_REQUIRE="container-station >= 2.0"
#QPKG_WEBUI=""
# Port number for the web interface.
QPKG_WEB_PORT="65000"

# Minimum QTS version requirement
QTS_MINI_VERSION="4.5.0"

# Select volume
# 1: support installation
# 2: support migration
# 3 (1+2): support both installation and migration
QPKG_VOLUME_SELECT=3

QPKG_TIMEOUT="180,180"
# Location of icons for the packaged application.
QDK_DATA_DIR_ICONS="icons"
# Location of files specific to x86 (64-bit) packages.
QDK_DATA_DIR_X86_64="x86_64"
# Location of files common to all architectures.
QDK_DATA_DIR_SHARED="shared"
# Location of building script for each architecture
#QDK_PRE_BUILD="src/build.sh"
#QNAP_CODE_SIGNING="1"
#QNAP_CODE_SIGNING_SERVER_IP="172.17.21.68"
#QNAP_CODE_SIGNING_SERVER_PORT="5000"
#QNAP_CODE_SIGNING_CSV="build_sign.csv"

Step 5 Generate QPKG File

Create Makefile
(build QPKG environment docker image and pull docker-compose used docker image save to x86_64 folder)

SHELL              := /bin/bash
BUILDER_IMAGE_NAME := qnap/qpkg-builder
BUILD_DIR          := build
SUPPORT_ARCH       := x86_64
CODESIGNING_TOKEN  ?= 

COLOR_YELLOW       := \033[33m
COLOR_BLUE         := \033[34m
COLOR_RESET        := \033[0m

.PHONY: build
build: docker-builder
  @if [ ! -f /.dockerenv ]; then \
    docker run --rm -t --name=build-capp-qpkg-$$$$ \
      -e QNAP_CODESIGNING_TOKEN=$(CODESIGNING_TOKEN) \
      -v /var/run/docker.sock:/var/run/docker.sock \
      -v $(PWD):/work \
      $(BUILDER_IMAGE_NAME) make _build; \
  else \
    $(MAKE) -$(MAKEFLAGS) _build; \
  fi

.PHONY: _build
_build: docker-image
  @echo -e "$(COLOR_BLUE)### Build QPKG ...$(COLOR_RESET)"
  fakeroot /usr/share/qdk2/QDK/bin/qbuild --build-dir $(BUILD_DIR) --xz amd64

.PHONY: docker-builder
docker-builder:
  @echo -e "$(COLOR_BLUE)### Prepare QPKG builder: $(BUILDER_IMAGE_NAME)$(COLOR_RESET)"
  docker build -t $(BUILDER_IMAGE_NAME) .

.PHONY: docker-image
docker-image:
  @for img in $(shell awk -F'image: ' '/image:/ {print $$2}' x86_64/docker-compose.yml); do \
    tarball=$$(echo $${img} | sed -e 's?/?-?' -e 's?:?_?').tar; \
    echo -e "$(COLOR_BLUE)### Download container image: $${img}$(COLOR_RESET)"; \
    docker pull $${img}; \
    echo -e "$(COLOR_YELLOW)### Save container image to a tar archive: $${tarball}$(COLOR_RESET)"; \
    mkdir -p x86_64/docker-images; \
    echo $${img} >> x86_64/docker-images/DOCKER_IMAGES; \
    docker save -o x86_64/docker-images/$${tarball} $${img}; \
  done

.PHONY: clean
clean:
  @echo -e "$(COLOR_BLUE)### Remove build files ...$(COLOR_RESET)"
  rm -rf */{data,docker-images}
  rm -rf build{,.*}/ tmp.*/

Use below command to build the QPKG file
```
[~/project_name] # make
```

The QPKG file will be generated in the build folder

[~/project_name] # ls -la build
total 243476
drwxr-xr-x 2 root   root        4096 Jun 30 15:23 .
drwxrwxr-x 7 edhong edhong      4096 Jun 30 15:23 ..
-rw-r--r-- 1 root   root   200426367 Jun 30 15:23 WordPress_5.7.2_x86_64.qpkg
-rw-r--r-- 1 root   root          68 Jun 30 15:23 WordPress_5.7.2_x86_64.qpkg.md5

Clean up

[~/project_name] # make clean
### Remove build files ...
rm -rf */{data,docker-images}
rm -rf build{,.*}/ tmp.*/

reference

Docker install doc:
https://docs.docker.com/engine/install/

Dockerfile doc:
https://docs.docker.com/engine/reference/builder/

docker-compose.yml doc:
https://docs.docker.com/compose/

package_routines doc:
https://edhongcy.gitbooks.io/qdk-qpkg-development-kit/content/package-specific-installation-functions.html

qpkg.cfg doc:
https://edhongcy.gitbooks.io/qdk-qpkg-development-kit/content/qpkg-configuration-file.html

QDK GitHub:
https://github.com/qnap-dev/QDK

qnap-packageing:
https://github.com/walkerlee/qnap-packaging

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

This project is teaching how to build containerized qpkg

Step 0 Ready build containerized qpkg Environment

Step 1 Download Sample Code

Step 2 Ready Build QPKG Environment Dockerfile

step 3 Create docker-compose.yml

Step 4 Edit qpkg install Script(package_routines) and Start-Stop Script

Step 5 Generate QPKG File

reference

About

Releases

Packages

Languages

Name		Name	Last commit message	Last commit date
Latest commit History 22 Commits
docs/images		docs/images
icons		icons
shared		shared
x86_64		x86_64
.dockerignore		.dockerignore
.gitignore		.gitignore
Dockerfile		Dockerfile
Makefile		Makefile
README.md		README.md
build_sign.csv		build_sign.csv
package_routines		package_routines
qpkg.cfg		qpkg.cfg

luckycloud-GmbH/containerized-qpkg

Folders and files

Latest commit

History

Repository files navigation

This project is teaching how to build containerized qpkg

Step 0 Ready build containerized qpkg Environment

Step 1 Download Sample Code

Step 2 Ready Build QPKG Environment Dockerfile

step 3 Create docker-compose.yml

Step 4 Edit qpkg install Script(package_routines) and Start-Stop Script

Step 5 Generate QPKG File

reference

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages