From 96ef6deb912b33ef1c462ac3af1661ce86f13008 Mon Sep 17 00:00:00 2001 From: Thomas <51749973+Thovi98@users.noreply.github.com> Date: Sun, 11 Feb 2024 12:17:34 +0100 Subject: [PATCH] some cleanings and tests --- conf/settings.js | 198 +++++++++++++++++++++------------------------ conf/variables.env | 86 ++++++++++---------- manifest.toml | 16 ++-- scripts/install | 33 ++++---- 4 files changed, 162 insertions(+), 171 deletions(-) diff --git a/conf/settings.js b/conf/settings.js index 354ad2c..0a63d27 100644 --- a/conf/settings.js +++ b/conf/settings.js @@ -18,10 +18,12 @@ const Path = require('path') // These credentials are used for authenticating api requests // between services that may need to go over public channels -const httpAuthUser = 'sharelatex' +const httpAuthUser = process.env.WEB_API_USER const httpAuthPass = process.env.WEB_API_PASSWORD const httpAuthUsers = {} -httpAuthUsers[httpAuthUser] = httpAuthPass +if (httpAuthUser && httpAuthPass) { + httpAuthUsers[httpAuthUser] = httpAuthPass +} const parse = function (option) { if (option != null) { @@ -53,32 +55,32 @@ const settings = { brandPrefix: '', port: __PORT__, - + allowAnonymousReadAndWriteSharing: process.env.SHARELATEX_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING === 'true', // Databases // --------- - // ShareLaTeX's main persistent data store is MongoDB (http://www.mongodb.org/) + // Overleaf Community Edition's main persistent data store is MongoDB (http://www.mongodb.org/) // Documentation about the URL connection string format can be found at: // // http://docs.mongodb.org/manual/reference/connection-string/ // // The following works out of the box with Mongo's default settings: mongo: { - url: process.env.SHARELATEX_MONGO_URL || 'mongodb://dockerhost/sharelatex', + url: process.env.OVERLEAF_MONGO_URL || 'mongodb://dockerhost/sharelatex', }, - // Redis is used in ShareLaTeX for high volume queries, like real-time + // Redis is used in Overleaf Community Edition for high volume queries, like real-time // editing, and session management. // // The following config will work with Redis's default settings: redis: { web: (redisConfig = { - host: process.env.SHARELATEX_REDIS_HOST || 'dockerhost', - port: process.env.SHARELATEX_REDIS_PORT || '6379', - password: process.env.SHARELATEX_REDIS_PASS || undefined, + host: process.env.OVERLEAF_REDIS_HOST || 'dockerhost', + port: process.env.OVERLEAF_REDIS_PORT || '6379', + password: process.env.OVERLEAF_REDIS_PASS || undefined, key_schema: { // document-updater blockingKey({ doc_id }) { @@ -177,35 +179,35 @@ const settings = { // Server Config // ------------- - // Where your instance of ShareLaTeX can be found publicly. This is used + // Where your instance of Overleaf Community Edition can be found publicly. This is used // when emails are sent out and in generated links: - siteUrl: (siteUrl = process.env.SHARELATEX_SITE_URL || 'http://localhost'), + siteUrl: (siteUrl = process.env.OVERLEAF_SITE_URL || 'http://localhost'), // Status page URL as displayed on the maintenance/500 pages. - statusPageUrl: process.env.SHARELATEX_STATUS_PAGE_URL, + statusPageUrl: process.env.OVERLEAF_STATUS_PAGE_URL, - // The name this is used to describe your ShareLaTeX Installation - appName: process.env.SHARELATEX_APP_NAME || 'ShareLaTeX (Community Edition)', + // The name this is used to describe your Overleaf Community Edition Installation + appName: process.env.OVERLEAF_APP_NAME || 'Overleaf Community Edition', restrictInvitesToExistingAccounts: - process.env.SHARELATEX_RESTRICT_INVITES_TO_EXISTING_ACCOUNTS === 'true', + process.env.OVERLEAF_RESTRICT_INVITES_TO_EXISTING_ACCOUNTS === 'true', nav: { title: - process.env.SHARELATEX_NAV_TITLE || - process.env.SHARELATEX_APP_NAME || - 'ShareLaTeX Community Edition', + process.env.OVERLEAF_NAV_TITLE || + process.env.OVERLEAF_APP_NAME || + 'Overleaf Community Edition', }, // The email address which users will be directed to as the main point of - // contact for this installation of ShareLaTeX. - adminEmail: process.env.SHARELATEX_ADMIN_EMAIL || 'placeholder@example.com', + // contact for this installation of Overleaf Community Edition. + adminEmail: process.env.OVERLEAF_ADMIN_EMAIL || 'placeholder@example.com', // If provided, a sessionSecret is used to sign cookies so that they cannot be // spoofed. This is recommended. security: { sessionSecret: - process.env.SHARELATEX_SESSION_SECRET || process.env.CRYPTO_RANDOM, + process.env.OVERLEAF_SESSION_SECRET || process.env.CRYPTO_RANDOM, }, // These credentials are used for authenticating api requests @@ -220,36 +222,36 @@ const settings = { // but should be set to true in production. cacheStaticAssets: true, - // If you are running ShareLaTeX over https, set this to true to send the + // If you are running Overleaf Community Edition over https, set this to true to send the // cookie with a secure flag (recommended). - secureCookie: process.env.SHARELATEX_SECURE_COOKIE != null, + secureCookie: process.env.OVERLEAF_SECURE_COOKIE != null, - // If you are running ShareLaTeX behind a proxy (like Apache, Nginx, etc) + // If you are running Overleaf Community Edition behind a proxy (like Apache, Nginx, etc) // then set this to true to allow it to correctly detect the forwarded IP // address and http/https protocol information. - behindProxy: process.env.SHARELATEX_BEHIND_PROXY || false, - trustedProxyIps: process.env.SHARELATEX_TRUSTED_PROXY_IPS, + behindProxy: process.env.OVERLEAF_BEHIND_PROXY || false, + trustedProxyIps: process.env.OVERLEAF_TRUSTED_PROXY_IPS, // The amount of time, in milliseconds, until the (rolling) cookie session expires cookieSessionLength: parseInt( - process.env.SHARELATEX_COOKIE_SESSION_LENGTH || 5 * 24 * 60 * 60 * 1000, // default 5 days + process.env.OVERLEAF_COOKIE_SESSION_LENGTH || 5 * 24 * 60 * 60 * 1000, // default 5 days 10 ), redisLockTTLSeconds: parseInt( - process.env.SHARELATEX_REDIS_LOCK_TTL_SECONDS || '60', + process.env.OVERLEAF_REDIS_LOCK_TTL_SECONDS || '60', 10 ), i18n: { subdomainLang: { www: { - lngCode: process.env.SHARELATEX_SITE_LANGUAGE || 'en', + lngCode: process.env.OVERLEAF_SITE_LANGUAGE || 'en', url: siteUrl, }, }, - defaultLng: process.env.SHARELATEX_SITE_LANGUAGE || 'en', + defaultLng: process.env.OVERLEAF_SITE_LANGUAGE || 'en', }, currentImageName: process.env.TEX_LIVE_DOCKER_IMAGE, @@ -269,7 +271,7 @@ const settings = { user: 'staging', pass: process.env.STAGING_PASSWORD, requestTimeout: parseInt( - process.env.SHARELATEX_HISTORY_V1_HTTP_REQUEST_TIMEOUT || '300000', // default is 5min + process.env.OVERLEAF_HISTORY_V1_HTTP_REQUEST_TIMEOUT || '300000', // default is 5min 10 ), }, @@ -291,48 +293,35 @@ const settings = { // # OPTIONAL CONFIGURABLE SETTINGS -if (process.env.SHARELATEX_LEFT_FOOTER != null) { +if (process.env.OVERLEAF_LEFT_FOOTER != null) { try { - settings.nav.left_footer = JSON.parse(process.env.SHARELATEX_LEFT_FOOTER) + settings.nav.left_footer = JSON.parse(process.env.OVERLEAF_LEFT_FOOTER) } catch (error) { e = error - console.error('could not parse SHARELATEX_LEFT_FOOTER, not valid JSON') + console.error('could not parse OVERLEAF_LEFT_FOOTER, not valid JSON') } } -if (process.env.SHARELATEX_RIGHT_FOOTER != null) { - settings.nav.right_footer = process.env.SHARELATEX_RIGHT_FOOTER +if (process.env.OVERLEAF_RIGHT_FOOTER != null) { + settings.nav.right_footer = process.env.OVERLEAF_RIGHT_FOOTER try { - settings.nav.right_footer = JSON.parse(process.env.SHARELATEX_RIGHT_FOOTER) + settings.nav.right_footer = JSON.parse(process.env.OVERLEAF_RIGHT_FOOTER) } catch (error1) { e = error1 - console.error('could not parse SHARELATEX_RIGHT_FOOTER, not valid JSON') + console.error('could not parse OVERLEAF_RIGHT_FOOTER, not valid JSON') } } -if (process.env.SHARELATEX_HEADER_IMAGE_URL != null) { - settings.nav.custom_logo = process.env.SHARELATEX_HEADER_IMAGE_URL +if (process.env.OVERLEAF_HEADER_IMAGE_URL != null) { + settings.nav.custom_logo = process.env.OVERLEAF_HEADER_IMAGE_URL } -if (process.env.SHARELATEX_HEADER_NAV_LINKS != null) { - console.error(`\ -# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # -# -# WARNING: SHARELATEX_HEADER_NAV_LINKS is no longer supported -# See https://github.com/sharelatex/sharelatex/wiki/Configuring-Headers,-Footers-&-Logo -# -# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #\ -`) -} - -if (process.env.SHARELATEX_HEADER_EXTRAS != null) { +if (process.env.OVERLEAF_HEADER_EXTRAS != null) { try { - settings.nav.header_extras = JSON.parse( - process.env.SHARELATEX_HEADER_EXTRAS - ) + settings.nav.header_extras = JSON.parse(process.env.OVERLEAF_HEADER_EXTRAS) } catch (error2) { e = error2 - console.error('could not parse SHARELATEX_HEADER_EXTRAS, not valid JSON') + console.error('could not parse OVERLEAF_HEADER_EXTRAS, not valid JSON') } } @@ -340,64 +329,63 @@ if (process.env.SHARELATEX_HEADER_EXTRAS != null) { // ------------- // // You must configure a mail server to be able to send invite emails from -// ShareLaTeX. The config settings are passed to nodemailer. See the nodemailer +// Overleaf Community Edition. The config settings are passed to nodemailer. See the nodemailer // documentation for available options: // // http://www.nodemailer.com/docs/transports -if (process.env.SHARELATEX_EMAIL_FROM_ADDRESS != null) { +if (process.env.OVERLEAF_EMAIL_FROM_ADDRESS != null) { settings.email = { - fromAddress: process.env.SHARELATEX_EMAIL_FROM_ADDRESS, - replyTo: process.env.SHARELATEX_EMAIL_REPLY_TO || '', - driver: process.env.SHARELATEX_EMAIL_DRIVER, + fromAddress: process.env.OVERLEAF_EMAIL_FROM_ADDRESS, + replyTo: process.env.OVERLEAF_EMAIL_REPLY_TO || '', + driver: process.env.OVERLEAF_EMAIL_DRIVER, parameters: { // AWS Creds - AWSAccessKeyID: process.env.SHARELATEX_EMAIL_AWS_SES_ACCESS_KEY_ID, - AWSSecretKey: process.env.SHARELATEX_EMAIL_AWS_SES_SECRET_KEY, + AWSAccessKeyID: process.env.OVERLEAF_EMAIL_AWS_SES_ACCESS_KEY_ID, + AWSSecretKey: process.env.OVERLEAF_EMAIL_AWS_SES_SECRET_KEY, // SMTP Creds - host: process.env.SHARELATEX_EMAIL_SMTP_HOST, - port: process.env.SHARELATEX_EMAIL_SMTP_PORT, - secure: parse(process.env.SHARELATEX_EMAIL_SMTP_SECURE), - ignoreTLS: parse(process.env.SHARELATEX_EMAIL_SMTP_IGNORE_TLS), - name: process.env.SHARELATEX_EMAIL_SMTP_NAME, - logger: process.env.SHARELATEX_EMAIL_SMTP_LOGGER === 'true', + host: process.env.OVERLEAF_EMAIL_SMTP_HOST, + port: process.env.OVERLEAF_EMAIL_SMTP_PORT, + secure: parse(process.env.OVERLEAF_EMAIL_SMTP_SECURE), + ignoreTLS: parse(process.env.OVERLEAF_EMAIL_SMTP_IGNORE_TLS), + name: process.env.OVERLEAF_EMAIL_SMTP_NAME, + logger: process.env.OVERLEAF_EMAIL_SMTP_LOGGER === 'true', }, - textEncoding: process.env.SHARELATEX_EMAIL_TEXT_ENCODING, + textEncoding: process.env.OVERLEAF_EMAIL_TEXT_ENCODING, template: { - customFooter: process.env.SHARELATEX_CUSTOM_EMAIL_FOOTER, + customFooter: process.env.OVERLEAF_CUSTOM_EMAIL_FOOTER, }, } - if (process.env.SHARELATEX_EMAIL_AWS_SES_REGION != null) { - settings.email.parameters.region = - process.env.SHARELATEX_EMAIL_AWS_SES_REGION + if (process.env.OVERLEAF_EMAIL_AWS_SES_REGION != null) { + settings.email.parameters.region = process.env.OVERLEAF_EMAIL_AWS_SES_REGION } if ( - process.env.SHARELATEX_EMAIL_SMTP_USER != null || - process.env.SHARELATEX_EMAIL_SMTP_PASS != null + process.env.OVERLEAF_EMAIL_SMTP_USER != null || + process.env.OVERLEAF_EMAIL_SMTP_PASS != null ) { settings.email.parameters.auth = { - user: process.env.SHARELATEX_EMAIL_SMTP_USER, - pass: process.env.SHARELATEX_EMAIL_SMTP_PASS, + user: process.env.OVERLEAF_EMAIL_SMTP_USER, + pass: process.env.OVERLEAF_EMAIL_SMTP_PASS, } } - if (process.env.SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH != null) { + if (process.env.OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH != null) { settings.email.parameters.tls = { rejectUnauthorized: parse( - process.env.SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH + process.env.OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH ), } } } // i18n -if (process.env.SHARELATEX_LANG_DOMAIN_MAPPING != null) { +if (process.env.OVERLEAF_LANG_DOMAIN_MAPPING != null) { settings.i18n.subdomainLang = parse( - process.env.SHARELATEX_LANG_DOMAIN_MAPPING + process.env.OVERLEAF_LANG_DOMAIN_MAPPING ) } @@ -406,24 +394,24 @@ if (process.env.SHARELATEX_LANG_DOMAIN_MAPPING != null) { // These restrict the passwords users can use when registering // opts are from http://antelle.github.io/passfield if ( - process.env.SHARELATEX_PASSWORD_VALIDATION_PATTERN || - process.env.SHARELATEX_PASSWORD_VALIDATION_MIN_LENGTH || - process.env.SHARELATEX_PASSWORD_VALIDATION_MAX_LENGTH + process.env.OVERLEAF_PASSWORD_VALIDATION_PATTERN || + process.env.OVERLEAF_PASSWORD_VALIDATION_MIN_LENGTH || + process.env.OVERLEAF_PASSWORD_VALIDATION_MAX_LENGTH ) { settings.passwordStrengthOptions = { - pattern: process.env.SHARELATEX_PASSWORD_VALIDATION_PATTERN || 'aA$3', + pattern: process.env.OVERLEAF_PASSWORD_VALIDATION_PATTERN || 'aA$3', length: { - min: process.env.SHARELATEX_PASSWORD_VALIDATION_MIN_LENGTH || 8, - max: process.env.SHARELATEX_PASSWORD_VALIDATION_MAX_LENGTH || 72, + min: process.env.OVERLEAF_PASSWORD_VALIDATION_MIN_LENGTH || 8, + max: process.env.OVERLEAF_PASSWORD_VALIDATION_MAX_LENGTH || 72, }, } } // ###################### -// ShareLaTeX Server Pro +// Overleaf Server Pro // ###################### -if (parse(process.env.SHARELATEX_IS_SERVER_PRO) === true) { +if (parse(process.env.OVERLEAF_IS_SERVER_PRO) === true) { settings.bypassPercentageRollouts = true settings.apis.references = { url: 'http://localhost:3040' } } @@ -464,21 +452,21 @@ if (process.env.SANDBOXED_COMPILES === 'true') { // Templates // --------- -if (process.env.SHARELATEX_TEMPLATES_USER_ID) { +if (process.env.OVERLEAF_TEMPLATES_USER_ID) { settings.templates = { mountPointUrl: '/templates', - user_id: process.env.SHARELATEX_TEMPLATES_USER_ID, + user_id: process.env.OVERLEAF_TEMPLATES_USER_ID, } settings.templateLinks = parse( - process.env.SHARELATEX_NEW_PROJECT_TEMPLATE_LINKS + process.env.OVERLEAF_NEW_PROJECT_TEMPLATE_LINKS ) } // /Learn // ------- -if (process.env.SHARELATEX_PROXY_LEARN != null) { - settings.proxyLearn = parse(process.env.SHARELATEX_PROXY_LEARN) +if (process.env.OVERLEAF_PROXY_LEARN != null) { + settings.proxyLearn = parse(process.env.OVERLEAF_PROXY_LEARN) if (settings.proxyLearn) { settings.nav.header_extras = [ { @@ -491,33 +479,33 @@ if (process.env.SHARELATEX_PROXY_LEARN != null) { // /References // ----------- -if (process.env.SHARELATEX_ELASTICSEARCH_URL != null) { +if (process.env.OVERLEAF_ELASTICSEARCH_URL != null) { settings.references.elasticsearch = { - host: process.env.SHARELATEX_ELASTICSEARCH_URL, + host: process.env.OVERLEAF_ELASTICSEARCH_URL, } } // filestore -switch (process.env.SHARELATEX_FILESTORE_BACKEND) { +switch (process.env.OVERLEAF_FILESTORE_BACKEND) { case 's3': settings.filestore = { backend: 's3', stores: { - user_files: process.env.SHARELATEX_FILESTORE_USER_FILES_BUCKET_NAME, + user_files: process.env.OVERLEAF_FILESTORE_USER_FILES_BUCKET_NAME, template_files: - process.env.SHARELATEX_FILESTORE_TEMPLATE_FILES_BUCKET_NAME, + process.env.OVERLEAF_FILESTORE_TEMPLATE_FILES_BUCKET_NAME, }, s3: { key: - process.env.SHARELATEX_FILESTORE_S3_ACCESS_KEY_ID || + process.env.OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID || process.env.AWS_ACCESS_KEY_ID, secret: - process.env.SHARELATEX_FILESTORE_S3_SECRET_ACCESS_KEY || + process.env.OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY || process.env.AWS_SECRET_ACCESS_KEY, - endpoint: process.env.SHARELATEX_FILESTORE_S3_ENDPOINT, - pathStyle: process.env.SHARELATEX_FILESTORE_S3_PATH_STYLE === 'true', + endpoint: process.env.OVERLEAF_FILESTORE_S3_ENDPOINT, + pathStyle: process.env.OVERLEAF_FILESTORE_S3_PATH_STYLE === 'true', region: - process.env.SHARELATEX_FILESTORE_S3_REGION || + process.env.OVERLEAF_FILESTORE_S3_REGION || process.env.AWS_DEFAULT_REGION, }, } diff --git a/conf/variables.env b/conf/variables.env index b80846f..8b2aabe 100644 --- a/conf/variables.env +++ b/conf/variables.env @@ -1,9 +1,10 @@ -SHARELATEX_APP_NAME="YunoHost Overleaf Community Edition" +OVERLEAF_APP_NAME="YunoHost Overleaf Community Edition" SHARELATEX_PORT=__PORT__ SHARELATEX_CONFIG="__INSTALL_DIR__/settings.js" ADMIN_PRIVILEGE_AVAILABLE=true OPTIMISE_PDF=true +SHARELATEX_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING=true NODE_ENV=production LOG_LEVEL=info @@ -11,15 +12,14 @@ WEB_API_USER="__APP__" WEB_API_PASSWORD=__WEB_API_PASSWORD__ CRYPTO_RANDOM=__CRYPTO_RANDOM__ -SHARELATEX_MONGO_URL="mongodb://127.0.0.1:27017/__DB_NAME__" +OVERLEAF_MONGO_URL="mongodb://127.0.0.1:27017/__DB_NAME__" -SHARELATEX_REDIS_HOST="localhost" +OVERLEAF_REDIS_HOST="localhost" REDIS_HOST="localhost" REDIS_PORT=6379 -SHARELATEX_SITE_LANGUAGE="__LANGUAGE__" - +OVERLEAF_SITE_LANGUAGE="__LANGUAGE__" ENABLED_LINKED_FILE_TYPES=project_file,project_output_file @@ -38,63 +38,65 @@ TEXMFVAR=__INSTALL_DIR__/tmp/texmf-var # NGINX_WORKER_CONNECTIONS=768 ## Set for TLS via nginx-proxy -SHARELATEX_BEHIND_PROXY=true -SHARELATEX_SECURE_COOKIE=false +OVERLEAF_BEHIND_PROXY=true +OVERLEAF_SECURE_COOKIE=false -SHARELATEX_SITE_URL=https://__DOMAIN__ +OVERLEAF_SITE_URL=https://__DOMAIN__ # SHARELATEX_NAV_TITLE=Our Overleaf Instance # SHARELATEX_HEADER_IMAGE_URL=http://somewhere.com/mylogo.png -SHARELATEX_ADMIN_EMAIL=admin@__DOMAIN__ +# OVERLEAF_ADMIN_EMAIL=admin@__DOMAIN__ # SHARELATEX_LEFT_FOOTER=[{"text":"Powered by Overleaf © 2021", "url": "https://www.overleaf.com"}, {"text": "Contact your support team", "url": "mailto:support@example.com"} ] # SHARELATEX_RIGHT_FOOTER=[{"text":"Hello I am on the Right"}] -SHARELATEX_EMAIL_FROM_ADDRESS=__APP__@__DOMAIN__ +OVERLEAF_EMAIL_FROM_ADDRESS=__APP__@__DOMAIN__ # SHARELATEX_EMAIL_AWS_SES_ACCESS_KEY_ID= # SHARELATEX_EMAIL_AWS_SES_SECRET_KEY= -SHARELATEX_EMAIL_SMTP_HOST=localhost -SHARELATEX_EMAIL_SMTP_PORT=587 -SHARELATEX_EMAIL_SMTP_SECURE=true -SHARELATEX_EMAIL_SMTP_USER=__APP__ -SHARELATEX_EMAIL_SMTP_PASS=__MAIL_PWD__ -SHARELATEX_EMAIL_SMTP_NAME=__APP__@__DOMAIN__ -# SHARELATEX_EMAIL_SMTP_LOGGER=false -# SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH=true -# SHARELATEX_EMAIL_SMTP_IGNORE_TLS=false -# SHARELATEX_CUSTOM_EMAIL_FOOTER=This system is run by department x +OVERLEAF_EMAIL_SMTP_HOST=localhost +OVERLEAF_EMAIL_SMTP_PORT=587 +OVERLEAF_EMAIL_SMTP_SECURE=true +OVERLEAF_EMAIL_SMTP_USER=__APP__ +OVERLEAF_EMAIL_SMTP_PASS=__MAIL_PWD__ +OVERLEAF_EMAIL_SMTP_NAME=__APP__@__DOMAIN__ +# OVERLEAF_EMAIL_SMTP_LOGGER=false +# OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH=true +# OVERLEAF_EMAIL_SMTP_IGNORE_TLS=false +# OVERLEAF_CUSTOM_EMAIL_FOOTER=This system is run by department x -OT_JWT_AUTH_KEY=__KEY__ +OT_JWT_AUTH_KEY=__JWT_KEY__ ################ ## Server Pro ## ################ -LDAP_SERVER=ldap://localhost:389 -LDAP_BASE=ou=users,dc=yunohost,dc=org -LDAP_BINDDN=uid=%u,ou=users,dc=yunohost,dc=org -LDAP_USER_FILTER='(&(permission=cn=__APP__.main,ou=permission,dc=yunohost,dc=org)(uid=%u))' -LDAP_ADMIN_GROUP_FILTER='(&(permission=cn=__APP__.admin,ou=permission,dc=yunohost,dc=org)(uid=%u))' -ALLOW_EMAIL_LOGIN=true -LDAP_CONTACT_FILTER='(permission=cn=__APP__.main,ou=permission,dc=yunohost,dc=org)' -LDAP_CONTACTS=false +OVERLEAF_IS_SERVER_PRO=true -# EXTERNAL_AUTH=ldap -# SHARELATEX_LDAP_URL=ldap://localhost:389 -# SHARELATEX_LDAP_SEARCH_BASE=ou=users,dc=yunohost,dc=org -# SHARELATEX_LDAP_SEARCH_FILTER=(uid={{username}}) -# SHARELATEX_LDAP_BIND_DN=cn=admin,dc=planetexpress,dc=com -# SHARELATEX_LDAP_BIND_CREDENTIALS=GoodNewsEveryone -# SHARELATEX_LDAP_EMAIL_ATT=mail -# SHARELATEX_LDAP_NAME_ATT=cn -# SHARELATEX_LDAP_LAST_NAME_ATT=sn -# SHARELATEX_LDAP_UPDATE_USER_DETAILS_ON_LOGIN=true +#LDAP_SERVER=ldap://localhost:389 +#LDAP_BASE=ou=users,dc=yunohost,dc=org +#LDAP_BINDDN=uid=%u,ou=users,dc=yunohost,dc=org +#LDAP_USER_FILTER='(&(permission=cn=__APP__.main,ou=permission,dc=yunohost,dc=org)(uid=%u))' +#LDAP_ADMIN_GROUP_FILTER='(&(permission=cn=__APP__.admin,ou=permission,dc=yunohost,dc=org)(uid=%u))' +#ALLOW_EMAIL_LOGIN=true +#LDAP_CONTACT_FILTER='(permission=cn=__APP__.main,ou=permission,dc=yunohost,dc=org)' +#LDAP_CONTACTS=false -# SHARELATEX_TEMPLATES_USER_ID=578773160210479700917ee5 -# SHARELATEX_NEW_PROJECT_TEMPLATE_LINKS=[{"name":"All Templates","url":"/templates/all"}] +EXTERNAL_AUTH=ldap +OVERLEAF_LDAP_URL=ldap://localhost:389 +OVERLEAF_LDAP_SEARCH_BASE=ou=users,dc=yunohost,dc=org +OVERLEAF_LDAP_SEARCH_FILTER="(uid={{username}})" +# OVERLEAF_LDAP_BIND_DN='' +# OVERLEAF_LDAP_BIND_CREDENTIALS='' +OVERLEAF_LDAP_EMAIL_ATT=mail +OVERLEAF_LDAP_NAME_ATT=cn +OVERLEAF_LDAP_LAST_NAME_ATT=sn +OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN=true + +# OVERLEAF_TEMPLATES_USER_ID=578773160210479700917ee5 +# OVERLEAF_NEW_PROJECT_TEMPLATE_LINKS=[{"name":"All Templates","url":"/templates/all"}] # TEX_LIVE_DOCKER_IMAGE=quay.io/sharelatex/texlive-full:2021.1 # ALL_TEX_LIVE_DOCKER_IMAGES=quay.io/sharelatex/texlive-full:2021.1,quay.io/sharelatex/texlive-full:2020.1 -# SHARELATEX_PROXY_LEARN=true +OVERLEAF_PROXY_LEARN=true diff --git a/manifest.toml b/manifest.toml index 8969041..b7f5e47 100644 --- a/manifest.toml +++ b/manifest.toml @@ -51,15 +51,15 @@ ram.runtime = "50M" [resources] [resources.sources] [resources.sources.main] - url = "https://github.com/overleaf/overleaf/archive/fdf8ebe001ec91dc3ab5c23b47bbbb03dc03d1bb.tar.gz" - sha256 = "802e3c0add7690c211fc039f94e1fceffe83040e7e60b0c340f35703087f1704" + url = "https://github.com/overleaf/overleaf/archive/ea4d63876aec15eea2b65923574d41a066b71477.tar.gz" + sha256 = "9c9cbae9db51b9da7de06a4486fc8e676ead6336732ea5057c0008821003642a" autoupdate.stategy = "latest_github_commit" - [resources.sources.ldap] - url = "https://github.com/smhaller/ldap-overleaf-sl/archive/38887b9a152a7f35de1637789179ca1b60a63143.tar.gz" - sha256 = "dc09531ee2dac273e3122a78dbcc3fedee4c90fcdac55a5dffe540247b5e5449" - in_subdir = 2 - autoupdate.strategy = "latest_github_tag" + # [resources.sources.ldap] + # url = "https://github.com/smhaller/ldap-overleaf-sl/archive/38887b9a152a7f35de1637789179ca1b60a63143.tar.gz" + # sha256 = "dc09531ee2dac273e3122a78dbcc3fedee4c90fcdac55a5dffe540247b5e5449" + # in_subdir = 2 + # autoupdate.strategy = "latest_github_tag" [resources.system_user] @@ -68,7 +68,7 @@ ram.runtime = "50M" [resources.install_dir] [resources.data_dir] - subdirs = ["compiles", "output", "cache"] + subdirs = [ "compiles", "output", "cache", "user_files", "template_files" ] [resources.permissions] main.url = "/" diff --git a/scripts/install b/scripts/install index 8d9b8d8..99ff83a 100755 --- a/scripts/install +++ b/scripts/install @@ -16,9 +16,9 @@ admin_mail=$(ynh_user_get_info --username=$admin --key=mail) ynh_app_setting_set --app=$app --key=crypto_random --value=$crypto_random ynh_app_setting_set --app=$app --key=web_api_password --value=$web_api_password -# key for the .env __KEY__ -key=$(ynh_string_random --length=45 | base64) -ynh_app_setting_set --app=$app --key=key --value=$key +# key for the .env __JWT_KEY__ +jwt_key=$(ynh_string_random --length=45 | base64) +ynh_app_setting_set --app=$app --key=jwt_key --value=$jwt_key #================================================= # STANDARD MODIFICATIONS @@ -49,7 +49,7 @@ ynh_script_progression --message="Setting up source files..." # Download, check integrity, uncompress and patch the source from app.src ynh_setup_source --dest_dir="$install_dir/build" -ynh_setup_source --dest_dir="$install_dir/build_ldap" --source_id="ldap" +#ynh_setup_source --dest_dir="$install_dir/build_ldap" --source_id="ldap" chmod 750 "$install_dir" chmod -R o-rwx "$install_dir" @@ -107,18 +107,19 @@ ynh_add_config --template="../conf/production.json" --destination="$install_dir/ ynh_add_config --template="../conf/production.json" --destination="$install_dir/live/services/history-v1/config/production.json" cp "$install_dir/build/server-ce/config/custom-environment-variables.json" "$install_dir/live/services/history-v1/config/" -#patch files for LDAP integration -patch "$install_dir/live/services/web/app/src/Features/Authentication/AuthenticationController.js" "$install_dir/build_ldap/sharelatex_diff/AuthenticationController.js.diff" -patch "$install_dir/live/services/web/app/src/Features/Authentication/AuthenticationManager.js" "$install_dir/build_ldap/sharelatex_diff/AuthenticationManager.js.diff" -patch "$install_dir/live/services/web/app/src/Features/Contacts/ContactController.js" "$install_dir/build_ldap/sharelatex_diff/ContactController.js.diff" -#patch "$install_dir/live/services/web/app/views/admin/index.pug" "$install_dir/build_ldap/sharelatex_diff/admin-index.pug.diff" -patch "$install_dir/live/services/web/app/views/admin/index.pug" "$install_dir/build_ldap/sharelatex_diff/admin-sysadmin.pug.diff" -patch "$install_dir/live/services/web/app/views/user/login.pug" "$install_dir/build_ldap/sharelatex_diff/login.pug.diff" -patch "$install_dir/live/services/web/app/views/layout/navbar-marketing.pug" "$install_dir/build_ldap/sharelatex_diff/navbar-marketing.pug.diff" -patch "$install_dir/live/services/web/app/views/layout/navbar.pug" "$install_dir/build_ldap/sharelatex_diff/navbar.pug.diff" -patch "$install_dir/live/services/web/app/src/router.js" "$install_dir/build_ldap/sharelatex_diff/router.js.diff" -patch "$install_dir/live/services/web/app/views/user/settings.pug" "$install_dir/build_ldap/sharelatex_diff/settings.pug.diff" + +#patch files for LDAP integration +#patch "$install_dir/live/services/web/app/src/Features/Authentication/AuthenticationController.js" "$install_dir/build_ldap/sharelatex_diff/AuthenticationController.js.diff" +#patch "$install_dir/live/services/web/app/src/Features/Authentication/AuthenticationManager.js" "$install_dir/build_ldap/sharelatex_diff/AuthenticationManager.js.diff" +#patch "$install_dir/live/services/web/app/src/Features/Contacts/ContactController.js" "$install_dir/build_ldap/sharelatex_diff/ContactController.js.diff" +#patch "$install_dir/live/services/web/app/views/admin/index.pug" "$install_dir/build_ldap/sharelatex_diff/admin-index.pug.diff" +#patch "$install_dir/live/services/web/app/views/admin/index.pug" "$install_dir/build_ldap/sharelatex_diff/admin-sysadmin.pug.diff" +#patch "$install_dir/live/services/web/app/views/user/login.pug" "$install_dir/build_ldap/sharelatex_diff/login.pug.diff" +#patch "$install_dir/live/services/web/app/views/layout/navbar-marketing.pug" "$install_dir/build_ldap/sharelatex_diff/navbar-marketing.pug.diff" +#patch "$install_dir/live/services/web/app/views/layout/navbar.pug" "$install_dir/build_ldap/sharelatex_diff/navbar.pug.diff" +#patch "$install_dir/live/services/web/app/src/router.js" "$install_dir/build_ldap/sharelatex_diff/router.js.diff" +#patch "$install_dir/live/services/web/app/views/user/settings.pug" "$install_dir/build_ldap/sharelatex_diff/settings.pug.diff" #sed -iE '/type=.*email.*/d' $install_dir/live/services/web/app/views/user/login.pug #sed -iE "s/email@example.com/${login_text:-user}/g" $install_dir/live/services/web/app/views/user/login.pug #sed -iE '/email@example.com/{n;N;N;d}' $install_dir/live/services/web/app/views/user/login.pug @@ -127,7 +128,7 @@ patch "$install_dir/live/services/web/app/views/user/settings.pug" "$install_dir #touch "$install_dir/live/services/web/app/views/project/editor/review-panel.pug" ynh_secure_remove --file="$install_dir/build" -ynh_secure_remove --file="$install_dir/build_ldap" +#ynh_secure_remove --file="$install_dir/build_ldap" ynh_script_progression --message="Building app..." pushd "$install_dir/live"