From 7323fab689d1ef1bf4876f42ce830eb02925a718 Mon Sep 17 00:00:00 2001 From: paspo Date: Thu, 31 Jul 2025 15:31:01 +0200 Subject: [PATCH] docs --- README.md | 44 +++++++++++++++++++++++--------------- docker-compose-sample.yaml | 11 ---------- 2 files changed, 27 insertions(+), 28 deletions(-) delete mode 100644 docker-compose-sample.yaml diff --git a/README.md b/README.md index 2feccb4..38f8adb 100644 --- a/README.md +++ b/README.md @@ -17,25 +17,35 @@ services: - 2222:22 # sftp access volumes: - ./data:/data - - ./ssh:/ssh # add authorized_keys file here - ./extra_nginx.conf:/etc/nginx/custom.d/extra.conf # optional - - ./htpasswd:/app/htpasswd # optional, for webdav auth environment: - LOG_DAYS: 14 # default 7 - WEBDAV_PORT: 8080 # default: 8080 - STATS_PORT: 8081 # default: 8081 - PHP: php84 # none (default), php82, php83, php84 - POSTSIZE: 256M # default: 256M - PUID: 1000 # default: 1000 - PGID: 1000 # default: 1000 - USERNAME: theuser # default: theuser - GROUPNAME: thegroup # default: thegroup - TZ: Etc/UTC # default: Etc/UTC - FPM_MAX_CHILDREN: 5 # default: 5 - FPM_START_SERVERS: 1 # default: 1 - FPM_MIN_SPARE_SERVERS: 1 # default: 1 - FPM_MAX_SPARE_SERVERS: 3 # default: 3 - DISABLE_WEBROOT_CHOWN: 1 # default: 0 + LOG_DAYS: 14 # default 7 + WEBDAV_PORT: 8080 # default: 8080 + STATS_PORT: 8081 # default: 8081 + PHP: php84 # none (default), php82, php83, php84 + POSTSIZE: 256M # default: 256M + PUID: 1000 # default: 1000 + PGID: 1000 # default: 1000 + USERNAME: theuser # default: theuser + GROUPNAME: thegroup # default: thegroup + TZ: Etc/UTC # default: Etc/UTC + FPM_MAX_CHILDREN: 5 # default: 5 + FPM_START_SERVERS: 1 # default: 1 + FPM_MIN_SPARE_SERVERS: 1 # default: 1 + FPM_MAX_SPARE_SERVERS: 3 # default: 3 + DISABLE_WEBROOT_CHOWN: 1 # default: 0 + DISABLE_SFTP: 1 # default: 0 ``` The `/data/www` and `/data/logs` directories and their contents will be chowned to `$PUID:$PGID` and chmodded to `0755` for directories and `0644` for files at container start. + +## data direcvtory layout + +| directory | content | +|-----------|-----------------------------------------------| +| auth | htpasswd files for stats and webdav | +| logs | nginx access logs (logrotated) and error logs | +| ssh | host keys and authorized keys | +| stats | html statistical report | +| stats.db | internal statistical db | +| www | webroot | diff --git a/docker-compose-sample.yaml b/docker-compose-sample.yaml deleted file mode 100644 index b5b86e6..0000000 --- a/docker-compose-sample.yaml +++ /dev/null @@ -1,11 +0,0 @@ -services: - web: - image: docker.asperti.com/paspo/webserver-nginx - ports: - - 8888:80 - - 2222:22 - volumes: - - ./www:/data/www - - ./ssh:/ssh # add authorized_keys file here - environment: - PHP: php84 # none (default), php82, php83, php84