add local file storage support

Author: vicalloy

Makefile

@@ -30,9 +30,11 @@ clean-docker: stop
 	${docker-compose} rm -fsv || true
 
 clean-conf:
-	rm -rfv env.* .env docker-compose.yml config/uc/fixtures/*.json
+	rm -rfv env.* .env docker-compose.yml config/uc/fixtures/*.json \
+		config/nginx
 
 clean-data: clean-docker
-	rm -rfv ./data/certs ./data/minio_root ./data/pgdata ./data/uc
+	rm -rfv ./data/certs ./data/minio_root \
+		./data/pgdata ./data/uc ./data/outline
 
 clean: clean-docker clean-conf

README.md

@@ -32,7 +32,7 @@ The config file [scripts/config.sh.sample](scripts/config.sh.sample)
 - `make start` start outline
 - `make stop` stop outline
 - `make clean` remove all config file generated by script.
-- `make clean-data` ⚠️ You will lost all your data
+- `make clean-data` ⚠️ You will lose all your data
 
 
 ## FAQ

scripts/config.sh.sample

@@ -1,3 +1,7 @@
+# Outline Wiki 0.72.0-1 supports local file storage.
+# Specify what storage system to use. Possible value is one of "s3" or "local".
+# For "local", the avatar images and document attachments will be saved on local disk. 
+FILE_STORAGE=s3
 # The url used to vist this web site.
 URL=http://127.0.0.1:8888
 # The default interface language. See translate.getoutline.com for a list of
@@ -14,7 +18,7 @@ FORCE_HTTPS=false
 ALLOWED_DOMAINS=
 
 # Docker image version
-OUTLINE_VERSION=0.67.2
+OUTLINE_VERSION=0.72.0-3
 POSTGRES_VERSION=15.2-alpine3.17
 MINIO_VERSION=RELEASE.2022-11-17T23-20-09Z
 MINIO_MC_VERSION=RELEASE.2022-11-17T21-20-39Z

scripts/main.sh

@@ -6,6 +6,8 @@
 # update config file
 MINIO_ACCESS_KEY=${MINIO_ACCESS_KEY:-`openssl rand -hex 8`}
 MINIO_SECRET_KEY=${MINIO_SECRET_KEY:-`openssl rand -hex 32`}
+# Should be: OIDC_CLIENT_SECRET=${OIDC_CLIENT_SECRET:-`openssl rand -hex 28`}
+# To maintain compatibility with old version, do not fix this bug.
 OIDC_CLIENT_SECRET=${MINIO_SECRET_KEY:-`openssl rand -hex 28`}
 OUTLINE_SECRET_KEY=${OUTLINE_SECRET_KEY:-`openssl rand -hex 32`}
 OUTLINE_UTILS_SECRET=${OUTLINE_UTILS_SECRET:-`openssl rand -hex 32`}
@@ -54,6 +56,7 @@ function create_outline_env_file {
     env_replace UTILS_SECRET $OUTLINE_UTILS_SECRET $env_file
     env_replace DEFAULT_LANGUAGE $DEFAULT_LANGUAGE $env_file
     env_replace FORCE_HTTPS $FORCE_HTTPS $env_file
+    env_replace FILE_STORAGE $FILE_STORAGE $env_file
 
     env_delete DATABASE_URL $env_file
     env_delete DATABASE_URL_TEST $env_file
@@ -70,7 +73,6 @@ function create_outline_env_file {
     env_replace AWS_SECRET_ACCESS_KEY $MINIO_SECRET_KEY $env_file
     env_replace AWS_S3_UPLOAD_BUCKET_URL $URL $env_file
 
-    env_add PGSSLMODE disable $env_file
     env_add ALLOWED_DOMAINS "$ALLOWED_DOMAINS" $env_file
 }
 
@@ -104,13 +106,23 @@ function create_uc_db_init_file {
 
 function create_env_files {
     create_global_env_file
-    create_minio_env_file
+    # DISABLE_MINIO
+    if [ $FILE_STORAGE == "s3" ]; then
+      create_minio_env_file
+    fi
     create_outline_env_file
     create_oidc_env_file
     create_uc_env_file
     create_uc_db_init_file
 }
 
+function create_apps_config {
+    cp -r ./templates/config/* ../config/
+    if [ $FILE_STORAGE != "s3" ]; then
+      rm_block "MINIO" "../config/nginx/default.conf"
+    fi
+}
+
 function create_docker_compose_file {
     fn=docker-compose.yml
     file=../$fn
@@ -119,12 +131,16 @@ function create_docker_compose_file {
     env_tmpl_replace NETWORKS "$NETWORKS" $file
     env_tmpl_replace MINIO_ACCESS_KEY "$MINIO_ACCESS_KEY" $file
     env_tmpl_replace MINIO_SECRET_KEY "$MINIO_SECRET_KEY" $file
+    if [ "$FILE_STORAGE" != "s3" ]; then
+      rm_block "MINIO" $file
+    fi
 }
 
 function init_cfg {
     update_config_file
     create_docker_compose_file
     create_env_files
+    create_apps_config
 }
 
 function reload_nginx {

config/nginx/default.conf renamed to scripts/templates/config/nginx/default.conf

@@ -2,11 +2,13 @@ server {
   listen        80;
   client_max_body_size 100m;
 
+##BEGIN MINIO 
   # Proxy requests to the bucket "outline" to MinIO server running on port 9000
   location /outline-bucket {
     include /etc/nginx/conf.d/include/proxy.conf;
     proxy_pass http://wk-minio:9000;
   }
+##END
 
   # Outline Wiki
   location / {

config/nginx/include/proxy.conf renamed to scripts/templates/config/nginx/include/proxy.conf

@@ -16,6 +16,7 @@ services:
     restart: always
     networks:
       - ${NETWORKS}
+##BEGIN MINIO 
   wk-minio:
     image: minio/minio:${MINIO_VERSION}
     volumes:
@@ -42,6 +43,7 @@ services:
       "
     networks:
       - ${NETWORKS}
+##END
   wk-outline:
     image: outlinewiki/outline:${OUTLINE_VERSION}
     command: sh -c "yarn db:migrate --env production-ssl-disabled && yarn start"
@@ -53,11 +55,15 @@ services:
     env_file:
       - ./env.outline
       - ./env.oidc
+    volumes:
+      - ./data/outline:/var/lib/outline/data
     restart: always
     depends_on:
       - wk-postgres
       - wk-redis
+##BEGIN MINIO 
       - wk-minio
+##END
     networks:
       - ${NETWORKS}
   wk-oidc-server:
@@ -80,7 +86,9 @@ services:
       - ./data/uc/static_root:/uc/static_root:ro
     restart: always
     depends_on:
+##BEGIN MINIO 
       - wk-minio
+##END
       - wk-outline
       - wk-oidc-server
     networks:

scripts/templates/docker-compose.yml

@@ -53,7 +53,7 @@ AWS_ACCESS_KEY_ID=get_a_key_from_aws
 AWS_SECRET_ACCESS_KEY=get_the_secret_of_above_key
 AWS_REGION=xx-xxxx-x
 AWS_S3_UPLOAD_BUCKET_URL=http://s3:4569
-AWS_S3_UPLOAD_BUCKET_NAME=bucket_name_here
+AWS_S3_UPLOAD_BUCKET_NAME=outline-bucket
 AWS_S3_UPLOAD_MAX_SIZE=26214400
 AWS_S3_FORCE_PATH_STYLE=true
 # uploaded s3 objects permission level, default is private
@@ -74,3 +74,18 @@ SMTP_REPLY_EMAIL=
 # See translate.getoutline.com for a list of available language codes and their
 # percentage translated.
 DEFAULT_LANGUAGE=en_US
+
+# Specify what storage system to use. Possible value is one of "s3" or "local".
+# For "local", the avatar images and document attachments will be saved on local disk. 
+FILE_STORAGE=local
+
+# If "local" is configured for FILE_STORAGE above, then this sets the parent directory under
+# which all attachments/images go. Make sure that the process has permissions to create
+# this path and also to write files to it.
+FILE_STORAGE_LOCAL_ROOT_DIR=/var/lib/outline/data
+
+# Maximum allowed size for the uploaded attachment.
+FILE_STORAGE_UPLOAD_MAX_SIZE=26214400
+
+# Disable SSL for connecting to Postgres
+PGSSLMODE=disable

scripts/templates/env.outline

@@ -45,3 +45,9 @@ function env_delete {
     filename=$2
     sed "/${key}/d" -i $filename
 }
+
+function rm_block {
+    block=$1
+    filename=$2
+    sed "/##BEGIN ${block}/,/##END/d" -i $filename
+}