From 3e6b396d0913e6747714a9f87e2161bba0ce525e Mon Sep 17 00:00:00 2001 From: Lauri Ojansivu Date: Sat, 10 Jun 2023 00:55:00 +0300 Subject: [PATCH] Clarified required settings for start-wekan.bat and start-wekan.sh . Thanks to xet7 ! --- start-wekan.bat | 29 +++++++++++++++++++++++++++++ start-wekan.sh | 42 +++++++++++++++++++++++++++--------------- 2 files changed, 56 insertions(+), 15 deletions(-) diff --git a/start-wekan.bat b/start-wekan.bat index b660415dc..4c2d96d46 100644 --- a/start-wekan.bat +++ b/start-wekan.bat @@ -1,5 +1,31 @@ @ECHO OFF +REM # ------------------- HOWTO --------------------- +REM # https://github.com/wekan/wekan/wiki/Offline + +REM #-------------------- REQUIRED SETTINGS START -------------------- + +REM # Writable path required to exist and be writable for attachments to migrate and work correctly +SET WRITABLE_PATH=.. + +REM # MongoDB database URL required +SET MONGO_URL=mongodb://127.0.0.1:27017/wekan + +REM # If port is 80, must change ROOT_URL to: http://YOUR-WEKAN-SERVER-IPv4-ADDRESS , like http://192.168.0.100 +REM # If port is not 80, must change ROOT_URL to: http://YOUR-WEKAN-SERVER-IPv4-ADDRESS:YOUR-PORT-NUMBER , like http://192.168.0.100:2000 +REM # If ROOT_URL is not correct, these do not work: translations, uploading attachments. +SET ROOT_URL=http://localhost:2000 + +REM # Must change to YOUR-PORT-NUMBER: +SET PORT=2000 + +REM #------------------- REQUIRED SETTINGS END ---------------------- + +REM #-------------------- OPTIONAL SETTINGS START ------------------- +REM # If at public Internet, required different settings: +REM # - For ROOT_URL: https://github.com/wekan/wekan/wiki/Settings +REM # - For SSL/TLS, also at above wiki right menu: config for Caddy/Nginx/Apache + REM ------------------------------------------------------------ REM # Debug OIDC OAuth2 etc. @@ -494,4 +520,7 @@ REM # SET NODE_OPTIONS="--max_old_space_size=4096" REM # Add more stack. ulimit is not at Windows, stack-size is at Windows: REM # bash -c "ulimit -s 65500; exec node --stack-size=65500 main.js" REM #node --stack-size=65500 main.js + +REM #-------------------- OPTIONAL SETTINGS END -------------------- + node main.js diff --git a/start-wekan.sh b/start-wekan.sh index 1209f0bbd..a6e037799 100755 --- a/start-wekan.sh +++ b/start-wekan.sh @@ -3,14 +3,32 @@ # If you want to restart even on crash, uncomment while and done lines. #while true; do cd .build/bundle - #--------------------------------------------- + #-------------------- REQUIRED SETTINGS START -------------------- + # WRITEABLE PATH REQUIRED TO EXISTS AND BE WRITABLE FOR ATTACHMENTS TO WORK + export WRITABLE_PATH=.. + #----------------------------------------------------------------- + # MongoDB database URL required + export MONGO_URL=mongodb://127.0.0.1:27017/wekan + #----------------------------------------------------------------- + # If port is 80, must change ROOT_URL to: http://YOUR-WEKAN-SERVER-IPv4-ADDRESS , like http://192.168.0.100 + # If port is not 80, must change ROOT_URL to: http://YOUR-WEKAN-SERVER-IPv4-ADDRESS:YOUR-PORT-NUMBER , like http://192.168.0.100:2000 + # If ROOT_URL is not correct, these do not work: translations, uploading attachments. + export ROOT_URL=http://localhost:2000 + # If at public Internet, required different SSL/TLS settings: + # - https://github.com/wekan/wekan/wiki/Settings + # - Also at wiki: SSL/TLS config for Caddy/Nginx/Apache + #----------------------------------------------------------------- + # Must change to YOUR-PORT-NUMBER: + export PORT=2000 + #-------------------- REQUIRED SETTINGS END ---------------------- + # + #-------------------- OPTIONAL SETTINGS START -------------------- + # If at public Internet, required different settings: + # - For ROOT_URL: https://github.com/wekan/wekan/wiki/Settings + # - For SSL/TLS, also at above wiki right menu: config for Caddy/Nginx/Apache + #----------------------------------------------------------------- # Debug OIDC OAuth2 etc. #export DEBUG=true - #--------------------------------------------- - export MONGO_URL='mongodb://127.0.0.1:27017/wekan' - #--------------------------------------------- - # WRITEABLE PATH - export WRITABLE_PATH=.. #----------------------------------------------------------------- # ==== AWS S3 FOR FILES ==== # Any region. For example: @@ -20,14 +38,9 @@ # #export S3='{"s3":{"key": "xxx", "secret": "xxx", "bucket": "xxx", "region": "xxx"}}' #----------------------------------------------------------------- - # Production: https://example.com/wekan - # Local: http://localhost:2000 - #export ipaddress=$(ifdata -pa eth0) - export ROOT_URL='http://localhost:2000' - #--------------------------------------------- # https://github.com/wekan/wekan/wiki/Troubleshooting-Mail # https://github.com/wekan/wekan-mongodb/blob/master/docker-compose.yml - export MAIL_URL='smtp://user:pass@mailserver.example.com:25/' + export MAIL_URL=smtp://user:pass@mailserver.example.com:25/ export MAIL_FROM='Wekan Boards ' # Currently MAIL_SERVICE is not in use. #export MAIL_SERVICE=Outlook365 @@ -36,15 +49,13 @@ #--------------------------------------------- #export KADIRA_OPTIONS_ENDPOINT=http://127.0.0.1:11011 #--------------------------------------------- - # This is local port where Wekan Node.js runs, same as below on Caddyfile settings. - export PORT=2000 #--------------------------------------------- # ==== NUMBER OF SEARCH RESULTS PER PAGE BY DEFAULT ==== #export RESULTS_PER_PAGE=20 #--------------------------------------------- # Wekan Export Board works when WITH_API=true. # If you disable Wekan API with false, Export Board does not work. - export WITH_API='true' + export WITH_API=true #--------------------------------------------------------------- # ==== PASSWORD BRUTE FORCE PROTECTION ==== #https://atmospherejs.com/lucasantoniassi/accounts-lockout @@ -536,6 +547,7 @@ # Add more stack: #bash -c "ulimit -s 65500; exec node --stack-size=65500 --trace-deprecation main.js" #bash -c "ulimit -s 65500; exec node --stack-size=65500 main.js" + #-------------------- OPTIONAL SETTINGS END ---------------------- bash -c "ulimit -s 65500; exec node main.js" #node main.js #---------------------------------------------------------------------