فهرست منبع

Config: Improve docs in docker-compose.yml files for developers

Michael Mayer 3 سال پیش
والد
کامیت
f94744eee1
6فایلهای تغییر یافته به همراه32 افزوده شده و 18 حذف شده
  1. 8 3
      docker-compose.db.yml
  2. 5 2
      docker-compose.drone.yml
  3. 3 3
      docker-compose.latest.yml
  4. 8 5
      docker-compose.postgres.yml
  5. 2 2
      docker-compose.proxy.yml
  6. 6 3
      docker-compose.yml

+ 8 - 3
docker-compose.db.yml

@@ -1,9 +1,9 @@
 version: '3.5'
 
-# Legacy Databases Servers (for developers only)
-
+## Legacy Databases Servers (for developers only)
 services:
-  ## Affected by MDEV-25362: Incorrect name resolution for subqueries in ON expressions
+  ## MariaDB 10.5.5 Database Server
+  ## affected by MDEV-25362: Incorrect name resolution for subqueries in ON expressions
   ## see https://jira.mariadb.org/browse/MDEV-25362
   mariadb-10-5-5:
     image: mariadb:10.5.5
@@ -18,6 +18,7 @@ services:
       MYSQL_PASSWORD: photoprism
       MYSQL_DATABASE: photoprism
 
+  ## MariaDB 10.3 Database Server
   mariadb-10-3:
     image: mariadb:10.3
     command: mysqld --port=4001 --transaction-isolation=READ-COMMITTED --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --max-connections=512 --innodb-rollback-on-timeout=OFF --innodb-lock-wait-timeout=120
@@ -31,6 +32,7 @@ services:
       MYSQL_PASSWORD: photoprism
       MYSQL_DATABASE: photoprism
 
+  ## MariaDB 10.2 Database Server
   mariadb-10-2:
     image: mariadb:10.2
     command: mysqld --port=4001 --transaction-isolation=READ-COMMITTED --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --max-connections=512 --innodb-rollback-on-timeout=OFF --innodb-lock-wait-timeout=120
@@ -44,6 +46,7 @@ services:
       MYSQL_PASSWORD: photoprism
       MYSQL_DATABASE: photoprism
 
+  ## MariaDB 10.1 Database Server
   mariadb-10-1:
     image: mariadb:10.1
     command: mysqld --port=4001 --transaction-isolation=READ-COMMITTED --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --max-connections=512 --innodb-rollback-on-timeout=OFF --innodb-lock-wait-timeout=120
@@ -57,6 +60,7 @@ services:
       MYSQL_PASSWORD: photoprism
       MYSQL_DATABASE: photoprism
 
+  ## MySQL 8 Database Server
   mysql-8:
     image: mysql:8
     command: mysqld --port=4001 --transaction-isolation=READ-COMMITTED --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --max-connections=512 --innodb-rollback-on-timeout=OFF --innodb-lock-wait-timeout=120
@@ -70,6 +74,7 @@ services:
       MYSQL_PASSWORD: photoprism
       MYSQL_DATABASE: photoprism
 
+## Join shared network
 networks:
   default:
     external:

+ 5 - 2
docker-compose.drone.yml

@@ -1,8 +1,8 @@
 version: '3.5'
 
-# Drone CI Test Environment
-
+## Continuous integration environment (for Drone CI)
 services:
+  ## App Server
   photoprism:
     build: .
     image: photoprism/photoprism:develop
@@ -141,6 +141,7 @@ services:
       DRONE_TAG:
       DRONE_TARGET_BRANCH:
 
+  ## MariaDB Database Server
   mariadb:
     image: mariadb:10.6
     command: mysqld --port=4001 --transaction-isolation=READ-COMMITTED --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --max-connections=512 --innodb-rollback-on-timeout=OFF --innodb-lock-wait-timeout=120
@@ -154,8 +155,10 @@ services:
       MYSQL_PASSWORD: photoprism
       MYSQL_DATABASE: photoprism
 
+  ## Dummy WebDAV Server (for testing)
   dummy-webdav:
     image: photoprism/dummy-webdav:20211022
 
+  ## Dummy OpenID Connect Server (for testing)
   dummy-oidc:
     image: photoprism/dummy-oidc:20211022

+ 3 - 3
docker-compose.latest.yml

@@ -1,9 +1,8 @@
 version: '3.5'
 
-# Stable Release (for developers only)
-
+## Stable Release (for testing only)
 services:
-  ## App Server (required)
+  ## App Server
   photoprism-latest:
     image: photoprism/photoprism:latest
     security_opt:
@@ -56,6 +55,7 @@ services:
       - "./storage/latest:/photoprism/storage"
       - "./storage/originals:/photoprism/originals"
 
+## Join shared network
 networks:
   default:
     external:

+ 8 - 5
docker-compose.postgres.yml

@@ -1,11 +1,10 @@
 version: '3.5'
 
-# For developers only! PostgreSQL is NOT supported yet as Gorm (the ORM library) needs to be
-# upgraded first. The current version does NOT support compatible general data types:
-# https://github.com/photoprism/photoprism/issues/47
-
+## For developers only! PostgreSQL is NOT supported yet as Gorm (the ORM library) needs to be
+## upgraded first. The current version does NOT support compatible general data types:
+## https://github.com/photoprism/photoprism/issues/47
 services:
-  ## App Server (required)
+  ## App Server
   photoprism:
     build: .
     image: photoprism/photoprism:develop
@@ -67,6 +66,7 @@ services:
       PHOTOPRISM_JPEG_QUALITY: 92             # Set to 95 for high-quality thumbnails (25-100)
       TF_CPP_MIN_LOG_LEVEL: 0                 # Show TensorFlow log messages for development
 
+  ## PostgreSQL Database Server
   postgres:
     image: postgres:12-alpine
     ports:
@@ -76,15 +76,18 @@ services:
       POSTGRES_USER: photoprism
       POSTGRES_PASSWORD: photoprism
 
+  ## Dummy WebDAV Server (for testing)
   dummy-webdav:
     image: photoprism/dummy-webdav:20211022
 
+  ## Dummy OpenID Connect Server (for testing)
   dummy-oidc:
     image: photoprism/dummy-oidc:20211022
     # Expose port 9998 on host
     # ports:
     #  - "9998:9998"
 
+## Join shared network
 volumes:
   go-mod:
     driver: local

+ 2 - 2
docker-compose.proxy.yml

@@ -1,7 +1,6 @@
 version: '3.5'
 
-# HTTP / HTTPS Reverse Proxy Servers (for developers only)
-
+## HTTP / HTTPS Reverse Proxy Servers (for developers only)
 services:
   ## Caddy 2
   caddy:
@@ -15,6 +14,7 @@ services:
       - ./docker/development/caddy:/data/caddy/pki/authorities/local
       - ./docker/development/caddy/Caddyfile:/etc/caddy/Caddyfile
 
+## Join shared network
 networks:
   default:
     external:

+ 6 - 3
docker-compose.yml

@@ -1,7 +1,6 @@
 version: '3.5'
 
-# Default environment with app server, database, and dummy services (for developers only)
-
+## Development environment with app server, database, and dummy services (for developers only)
 services:
   ## App Server
   photoprism:
@@ -89,7 +88,7 @@ services:
       - ".:/go/src/github.com/photoprism/photoprism"
       - "go-mod:/go/pkg/mod"
 
-  ## Database Server
+  ## MariaDB Database Server
   mariadb:
     image: mariadb:10.6
     command: mysqld --port=4001 --transaction-isolation=READ-COMMITTED --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --max-connections=512 --innodb-rollback-on-timeout=OFF --innodb-lock-wait-timeout=120
@@ -105,19 +104,23 @@ services:
       MYSQL_PASSWORD: photoprism
       MYSQL_DATABASE: photoprism
 
+  ## Dummy WebDAV Server (for testing)
   dummy-webdav:
     image: photoprism/dummy-webdav:20211022
 
+  ## Dummy OpenID Connect Server (for testing)
   dummy-oidc:
     image: photoprism/dummy-oidc:20211022
     # Expose port 9998 on host
     # ports:
     #  - "9998:9998"
 
+## Create named volumes
 volumes:
   go-mod:
     driver: local
 
+## Create shared network
 networks:
   default:
     name: shared