mirror of
https://github.com/overleaf/toolkit.git
synced 2025-04-19 15:28:06 +02:00
Merge pull request #130 from overleaf/jpa-s3
[misc] add variables for S3 and let doctor flag an incomplete S3 config
This commit is contained in:
Jakob Ackermann
GitHub
commit
69c04ffaaa
3 changed files with 154 additions and 0 deletions
|
|
@ -1,5 +1,10 @@
|
|||
# Changelog
|
||||
|
||||
## 2023-02-28
|
||||
### Added
|
||||
- Add variables for S3
|
||||
- Extend doctor script to flag incomplete S3 config
|
||||
|
||||
## 2022-08-16
|
||||
### Added
|
||||
- Updated default [`version`](https://github.com/overleaf/toolkit/blob/master/lib/config-seed/version) to `3.2.0`.
|
||||
|
|
|
|||
88
bin/doctor
88
bin/doctor
|
|
@ -254,6 +254,94 @@ function check_config_files() {
|
|||
if [[ "${TLS_PORT:-null}" != "null" ]]; then
|
||||
print_point 2 "TLS_PORT: $TLS_PORT"
|
||||
fi
|
||||
|
||||
elif [[ "$config_file" == "config/variables.env" ]]; then
|
||||
print_point 1 "values"
|
||||
|
||||
# Load vars from the rc file
|
||||
# shellcheck disable=SC1090
|
||||
source "$TOOLKIT_ROOT/$config_file"
|
||||
|
||||
if [[ "${SHARELATEX_FILESTORE_BACKEND:-fs}" == "s3" ]]; then
|
||||
print_point 2 "SHARELATEX_FILESTORE_BACKEND: s3"
|
||||
if [[ "${SHARELATEX_FILESTORE_USER_FILES_BUCKET_NAME:-null}" != "null" ]]; then
|
||||
print_point 2 "SHARELATEX_FILESTORE_USER_FILES_BUCKET_NAME: $SHARELATEX_FILESTORE_USER_FILES_BUCKET_NAME"
|
||||
else
|
||||
add_warning "SHARELATEX_FILESTORE_USER_FILES_BUCKET_NAME is unset"
|
||||
fi
|
||||
if [[ "${SHARELATEX_FILESTORE_TEMPLATE_FILES_BUCKET_NAME:-null}" != "null" ]]; then
|
||||
print_point 2 "SHARELATEX_FILESTORE_TEMPLATE_FILES_BUCKET_NAME: $SHARELATEX_FILESTORE_TEMPLATE_FILES_BUCKET_NAME"
|
||||
else
|
||||
add_warning "SHARELATEX_FILESTORE_TEMPLATE_FILES_BUCKET_NAME is unset"
|
||||
fi
|
||||
if [[ "${SHARELATEX_FILESTORE_S3_ENDPOINT:-null}" != "null" ]]; then
|
||||
print_point 2 "SHARELATEX_FILESTORE_S3_ENDPOINT: [set here]"
|
||||
else
|
||||
print_point 2 "SHARELATEX_FILESTORE_S3_ENDPOINT: Using AWS S3"
|
||||
fi
|
||||
if [[ "${SHARELATEX_FILESTORE_S3_PATH_STYLE:-null}" == "true" ]]; then
|
||||
print_point 2 "SHARELATEX_FILESTORE_S3_PATH_STYLE: true"
|
||||
else
|
||||
print_point 2 "SHARELATEX_FILESTORE_S3_PATH_STYLE: false"
|
||||
fi
|
||||
if [[ "${SHARELATEX_FILESTORE_S3_REGION:-null}" != "null" ]]; then
|
||||
print_point 2 "SHARELATEX_FILESTORE_S3_REGION: $SHARELATEX_FILESTORE_S3_REGION"
|
||||
else
|
||||
print_point 2 "SHARELATEX_FILESTORE_S3_REGION: <unset>"
|
||||
fi
|
||||
if [[ "${SHARELATEX_FILESTORE_S3_ACCESS_KEY_ID:-null}" != "null" ]]; then
|
||||
print_point 2 "SHARELATEX_FILESTORE_S3_ACCESS_KEY_ID: [set here]"
|
||||
else
|
||||
add_warning "SHARELATEX_FILESTORE_S3_ACCESS_KEY_ID is missing"
|
||||
fi
|
||||
if [[ "${SHARELATEX_FILESTORE_S3_SECRET_ACCESS_KEY:-null}" != "null" ]]; then
|
||||
print_point 2 "SHARELATEX_FILESTORE_S3_SECRET_ACCESS_KEY: [set here]"
|
||||
else
|
||||
add_warning "SHARELATEX_FILESTORE_S3_SECRET_ACCESS_KEY is missing"
|
||||
fi
|
||||
else
|
||||
print_point 2 "SHARELATEX_FILESTORE_BACKEND: fs"
|
||||
fi
|
||||
if [[ "${SHARELATEX_HISTORY_BACKEND:-fs}" == "s3" ]]; then
|
||||
print_point 2 "SHARELATEX_HISTORY_BACKEND: s3"
|
||||
if [[ "${SHARELATEX_HISTORY_PROJECT_BLOBS_BUCKET:-null}" != "null" ]]; then
|
||||
print_point 2 "SHARELATEX_HISTORY_PROJECT_BLOBS_BUCKET: $SHARELATEX_HISTORY_PROJECT_BLOBS_BUCKET"
|
||||
else
|
||||
add_warning "SHARELATEX_HISTORY_PROJECT_BLOBS_BUCKET is unset"
|
||||
fi
|
||||
if [[ "${SHARELATEX_HISTORY_CHUNKS_BUCKET:-null}" != "null" ]]; then
|
||||
print_point 2 "SHARELATEX_HISTORY_CHUNKS_BUCKET: $SHARELATEX_HISTORY_CHUNKS_BUCKET"
|
||||
else
|
||||
add_warning "SHARELATEX_HISTORY_CHUNKS_BUCKET is unset"
|
||||
fi
|
||||
if [[ "${SHARELATEX_HISTORY_S3_ENDPOINT:-null}" != "null" ]]; then
|
||||
print_point 2 "SHARELATEX_HISTORY_S3_ENDPOINT: [set here]"
|
||||
else
|
||||
print_point 2 "SHARELATEX_HISTORY_S3_ENDPOINT: Using AWS S3"
|
||||
fi
|
||||
if [[ "${SHARELATEX_HISTORY_S3_PATH_STYLE:-null}" == "true" ]]; then
|
||||
print_point 2 "SHARELATEX_HISTORY_S3_PATH_STYLE: true"
|
||||
else
|
||||
print_point 2 "SHARELATEX_HISTORY_S3_PATH_STYLE: false"
|
||||
fi
|
||||
if [[ "${SHARELATEX_HISTORY_S3_REGION:-null}" != "null" ]]; then
|
||||
print_point 2 "SHARELATEX_HISTORY_S3_REGION: $SHARELATEX_HISTORY_S3_REGION"
|
||||
else
|
||||
print_point 2 "SHARELATEX_HISTORY_S3_REGION: <unset>"
|
||||
fi
|
||||
if [[ "${SHARELATEX_HISTORY_S3_ACCESS_KEY_ID:-null}" != "null" ]]; then
|
||||
print_point 2 "SHARELATEX_HISTORY_S3_ACCESS_KEY_ID: [set here]"
|
||||
else
|
||||
add_warning "SHARELATEX_HISTORY_S3_ACCESS_KEY_ID is missing"
|
||||
fi
|
||||
if [[ "${SHARELATEX_HISTORY_S3_SECRET_ACCESS_KEY:-null}" != "null" ]]; then
|
||||
print_point 2 "SHARELATEX_HISTORY_S3_SECRET_ACCESS_KEY: [set here]"
|
||||
else
|
||||
add_warning "SHARELATEX_HISTORY_S3_SECRET_ACCESS_KEY is missing"
|
||||
fi
|
||||
else
|
||||
print_point 2 "SHARELATEX_HISTORY_BACKEND: fs"
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
done
|
||||
|
|
|
|||
|
|
@ -66,3 +66,64 @@ EXTERNAL_AUTH=none
|
|||
# ALL_TEX_LIVE_DOCKER_IMAGES=quay.io/sharelatex/texlive-full:2022.1,quay.io/sharelatex/texlive-full:2021.1,quay.io/sharelatex/texlive-full:2020.1
|
||||
|
||||
# SHARELATEX_PROXY_LEARN=true
|
||||
|
||||
# S3
|
||||
# Docs: https://github.com/overleaf/overleaf/wiki/S3
|
||||
# ## Enable the s3 backend for filestore
|
||||
# SHARELATEX_FILESTORE_BACKEND=s3
|
||||
# ## Enable S3 backend for history
|
||||
# SHARELATEX_HISTORY_BACKEND=s3
|
||||
# #
|
||||
# # Pick one of the two sections "AWS S3" or "Self-hosted S3".
|
||||
# #
|
||||
# # AWS S3
|
||||
# ## Bucket name for project files
|
||||
# SHARELATEX_FILESTORE_USER_FILES_BUCKET_NAME=overleaf-user-files
|
||||
# ## Bucket name for template files
|
||||
# SHARELATEX_FILESTORE_TEMPLATE_FILES_BUCKET_NAME=overleaf-template-files
|
||||
# ## Key for filestore user
|
||||
# SHARELATEX_FILESTORE_S3_ACCESS_KEY_ID=...
|
||||
# ## Secret for filestore user
|
||||
# SHARELATEX_FILESTORE_S3_SECRET_ACCESS_KEY=...
|
||||
# ## Bucket region you picked when creating the buckets.
|
||||
# SHARELATEX_FILESTORE_S3_REGION=""
|
||||
# ## Bucket name for project history blobs
|
||||
# SHARELATEX_HISTORY_PROJECT_BLOBS_BUCKET=overleaf-project-blobs
|
||||
# ## Bucket name for history chunks
|
||||
# SHARELATEX_HISTORY_CHUNKS_BUCKET=overleaf-chunks
|
||||
# ## Key for history user
|
||||
# SHARELATEX_HISTORY_S3_ACCESS_KEY_ID=...
|
||||
# ## Secret for history user
|
||||
# SHARELATEX_HISTORY_S3_SECRET_ACCESS_KEY=...
|
||||
# ## Bucket region you picked when creating the buckets.
|
||||
# SHARELATEX_HISTORY_S3_REGION=""
|
||||
#
|
||||
# # Self-hosted S3
|
||||
# ## Bucket name for project files
|
||||
# SHARELATEX_FILESTORE_USER_FILES_BUCKET_NAME=overleaf-user-files
|
||||
# ## Bucket name for template files
|
||||
# SHARELATEX_FILESTORE_TEMPLATE_FILES_BUCKET_NAME=overleaf-template-files
|
||||
# ## Key for filestore user
|
||||
# SHARELATEX_FILESTORE_S3_ACCESS_KEY_ID=...
|
||||
# ## Secret for filestore user
|
||||
# SHARELATEX_FILESTORE_S3_SECRET_ACCESS_KEY=...
|
||||
# ## S3 provider endpoint
|
||||
# SHARELATEX_FILESTORE_S3_ENDPOINT=http://10.10.10.10:9000
|
||||
# ## Path style addressing of buckets. Most likely you need to set this to "true".
|
||||
# SHARELATEX_FILESTORE_S3_PATH_STYLE="true"
|
||||
# ## Bucket region. Most likely you do not need to configure this.
|
||||
# SHARELATEX_FILESTORE_S3_REGION=""
|
||||
# ## Bucket name for project history blobs
|
||||
# SHARELATEX_HISTORY_PROJECT_BLOBS_BUCKET=overleaf-project-blobs
|
||||
# ## Bucket name for history chunks
|
||||
# SHARELATEX_HISTORY_CHUNKS_BUCKET=overleaf-chunks
|
||||
# ## Key for history user
|
||||
# SHARELATEX_HISTORY_S3_ACCESS_KEY_ID=...
|
||||
# ## Secret for history user
|
||||
# SHARELATEX_HISTORY_S3_SECRET_ACCESS_KEY=...
|
||||
# ## S3 provider endpoint
|
||||
# SHARELATEX_HISTORY_S3_ENDPOINT=http://10.10.10.10:9000
|
||||
# ## Path style addressing of buckets. Most likely you need to set this to "true".
|
||||
# SHARELATEX_HISTORY_S3_PATH_STYLE="true"
|
||||
# ## Bucket region. Most likely you do not need to configure this.
|
||||
# SHARELATEX_HISTORY_S3_REGION=""
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue