Add service and build

Author: d-lebed

.github/workflows/build_docker_image.yml

@@ -0,0 +1,62 @@
+name: Publish Docker image
+on:
+  push:
+    branches:
+      - main
+      - develop
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+  pull_request:
+    branches:
+      - "main"
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository_owner }}/vsftpd
+
+jobs:
+  build-and-push-image:
+    name: Build and push Docker image
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Login to the registry
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract image metadata
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern=v{{version}}
+            type=semver,pattern=v{{major}}.{{minor}}
+            type=semver,pattern=v{{major}}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Build and push
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: true
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

Dockerfile

@@ -0,0 +1,14 @@
+FROM alpine:3
+
+RUN apk add --no-cache \
+    bash \
+    vsftpd \
+    openssl \
+    && rm -rf /var/cache/apk/*
+
+COPY vsftpd.conf /etc/vsftpd/vsftpd.conf
+
+COPY entrypoint.sh /usr/local/bin/entrypoint.sh
+RUN chmod +x /usr/local/bin/entrypoint.sh
+
+CMD ["/usr/local/bin/entrypoint.sh"]

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Dmitry Lebed
+Copyright (c) 2023 Dzmitry Lebiadz
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,27 @@
 # vsftpd-docker
+
 vsftpf (very secure FTP daemon) alpine container
+
+## Available options
+
+| Option        | Description                           |
+| ------------- | ------------------------------------- |
+| `FTP_USER`    | Username for login. `user` by deafult |
+| `FTP_PASS`    | Password for login. `pass` by default |
+| `FTP_LOGGING` | Enable logging. `NO` by default       |
+
+Other options may be set using `VSFTPD_` prefix. For example to enable passive mode you can do next:
+
+```bash
+docker run -d \
+  -p 20-21:20-21 \
+  -p 21100-21110:21100-21110 \
+  -e FTP_USER=<user> \
+  -e FTP_PASS=<password> \
+  -e VSFTPD_pasv_enable=YES \
+  -e VSFTPD_pasv_address=<server_ip> \
+  -e VSFTPD_pasv_min_port=21100 \
+  -e VSFTPD_pasv_max_port=21110 \
+  -v /path/to/ftp:/home/vsftpd/<user> \
+  --name vsftpd --restart=always m0thman/vsftpd
+```

entrypoint.sh

@@ -0,0 +1,50 @@
+#!/usr/bin/env bash
+
+FTP_USER=${FTP_USER:-user}
+FTP_PASS=${FTP_PASS:-pass}
+FTP_LOGGING=${FTP_LOGGING:-NO}
+
+# Prepare user and directory
+addgroup -g 1212 $FTP_USER
+adduser -D -h /home/vsftpd/$FTP_USER -s /bin/false -G $FTP_USER -u 1212 $FTP_USER
+echo "$FTP_USER:$FTP_PASS" | /usr/sbin/chpasswd
+chown -R $FTP_USER:$FTP_USER /home/vsftpd/$FTP_USER
+
+# Prepare config file
+CONFIG_FILE=/etc/vsftpd/vsftpd.conf
+
+# Disable logging if FTP_LOGGING is not YES
+if [ "$FTP_LOGGING" != "YES" ]; then
+  sed -i 's/^xferlog_enable=.*/xferlog_enable=NO/' "$CONFIG_FILE"
+  sed -i 's/^log_ftp_protocol=.*/log_ftp_protocol=NO/' "$CONFIG_FILE"
+fi
+
+# Copy environment variables starting with VSFTPD_ and append them to CONFIG_FILE file
+for var in $(env | grep '^VSFTPD_'); do
+  name=$(echo "$var" | awk -F= '{print $1}')
+  value=$(echo "$var" | awk -F= '{print $2}')
+
+  echo "${name#VSFTPD_}=$value" >> "$CONFIG_FILE"
+done
+
+cat << TXT
+*******************************************************
+*               Server configuration                  *
+*******************************************************
+TXT
+cat "$CONFIG_FILE"
+cat << TXT
+*******************************************************
+TXT
+
+# Start logging if FTP_LOGGING is YES
+if [ "$FTP_LOGGING" = "YES" ]; then
+  echo "Enabling logging"
+
+  LOG_FILE=`grep ^vsftpd_log_file $CONFIG_FILE | cut -d= -f2`
+  touch $LOG_FILE
+  tail -f $LOG_FILE >> /dev/stdout &
+fi
+
+# Run vsftpd
+exec /usr/sbin/vsftpd $CONFIG_FILE

vsftpd.conf

@@ -0,0 +1,28 @@
+anonymous_enable=NO
+#anon_upload_enable=YES
+#anon_mkdir_write_enable=YES
+
+local_enable=YES
+chroot_local_user=YES
+passwd_chroot_enable=YES
+allow_writeable_chroot=YES
+
+write_enable=YES
+local_umask=022
+
+ftpd_banner=Welcome to FTP service.
+dirmessage_enable=YES
+connect_from_port_20=YES
+
+listen=YES
+#listen_ipv6=YES
+
+# Logging
+xferlog_enable=YES
+xferlog_file=/var/log/xferlog.log
+xferlog_std_format=NO
+
+log_ftp_protocol=YES
+vsftpd_log_file=/var/log/vsftpd.log
+
+# Other options