Meteor.js forums

Is settings.json still relevant?

tidee March 1, 2015, 2:16am 1

Can a settings.json file be used in the root of a project in order to affect the application? If so, could someone point me in the direction of some documentation on this?

Sanjo March 1, 2015, 2:19am 2

http://docs.meteor.com/#/full/meteor_settings

storyteller December 22, 2023, 4:48pm 3

As of December 2023 the docs are here:

And it is still very relevant.

xet7 December 22, 2023, 7:34pm 4

I currently use environment variables for most settings at all platforms. Supporting all platforms at same main branch.

Docker

github.com

wekan/wekan/blob/main/docker-compose.yml

version: '2'

# Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
#---------------------------------------------------------------------------------------------------------
# ==== CREATING USERS AND LOGGING IN TO WEKAN ====
# https://github.com/wekan/wekan/wiki/Adding-users
#---------------------------------------------------------------------------------------------------------
# ==== FORGOT PASSWORD ====
# https://github.com/wekan/wekan/wiki/Forgot-Password
#---------------------------------------------------------------------------------------------------------
# ==== Upgrading Wekan to new version =====
# NOTE: MongoDB has changed from 3.x to 4.x, in that case you need backup/restore with --noIndexRestore
#       see https://github.com/wekan/wekan/wiki/Backup
# 1) Stop Wekan:
#      docker-compose stop
# 2) Remove old Wekan app (wekan-app only, not that wekan-db container that has all your data)
#      docker rm wekan-app
# 3) Get newest docker-compose.yml from https://github.com/wekan/wekan to have correct image,
#    for example: "image: quay.io/wekan/wekan" or version tag "image: quay.io/wekan/wekan:v4.52"
# 4) Start Wekan:

This file has been truncated. show original

Snap

github.com

wekan/wekan/blob/main/snap-src/bin/config

#!/bin/sh

# All supported keys are defined here together with descriptions and default values

# list of supported keys
keys="DEBUG S3 MONGO_LOG_DESTINATION MONGO_URL MONGODB_BIND_UNIX_SOCKET MONGO_URL MONGODB_BIND_IP MONGODB_PORT MAIL_URL MAIL_FROM MAIL_SERVICE MAIL_SERVICE_USER MAIL_SERVICE_PASSWORD ROOT_URL PORT DISABLE_MONGODB CADDY_ENABLED CADDY_BIND_PORT WITH_API RICHER_CARD_COMMENT_EDITOR CARD_OPENED_WEBHOOK_ENABLED ACCOUNTS_LOCKOUT_KNOWN_USERS_FAILURES_BEFORE ACCOUNTS_LOCKOUT_KNOWN_USERS_PERIOD ACCOUNTS_LOCKOUT_KNOWN_USERS_FAILURE_WINDOW ACCOUNTS_LOCKOUT_UNKNOWN_USERS_FAILURES_BERORE ACCOUNTS_LOCKOUT_UNKNOWN_USERS_LOCKOUT_PERIOD ACCOUNTS_LOCKOUT_UNKNOWN_USERS_FAILURE_WINDOW ACCOUNTS_COMMON_LOGIN_EXPIRATION_IN_DAYS ATTACHMENTS_UPLOAD_EXTERNAL_PROGRAM ATTACHMENTS_UPLOAD_MIME_TYPES ATTACHMENTS_UPLOAD_MAX_SIZE AVATARS_UPLOAD_EXTERNAL_PROGRAM AVATARS_UPLOAD_MIME_TYPES AVATARS_UPLOAD_MAX_SIZE MAX_IMAGE_PIXEL IMAGE_COMPRESS_RATIO BIGEVENTS_PATTERN NOTIFICATION_TRAY_AFTER_READ_DAYS_BEFORE_REMOVE NOTIFY_DUE_DAYS_BEFORE_AND_AFTER NOTIFY_DUE_AT_HOUR_OF_DAY DEFAULT_BOARD_ID EMAIL_NOTIFICATION_TIMEOUT CORS CORS_ALLOW_HEADERS CORS_EXPOSE_HEADERS MATOMO_ADDRESS MATOMO_SITE_ID MATOMO_DO_NOT_TRACK MATOMO_WITH_USERNAME METRICS_ALLOWED_IP_ADDRESSES BROWSER_POLICY_ENABLED TRUSTED_URL WEBHOOKS_ATTRIBUTES OAUTH2_ENABLED OIDC_REDIRECTION_ENABLED OAUTH2_CA_CERT OAUTH2_LOGIN_STYLE OAUTH2_CLIENT_ID OAUTH2_SECRET OAUTH2_SERVER_URL OAUTH2_AUTH_ENDPOINT OAUTH2_USERINFO_ENDPOINT OAUTH2_TOKEN_ENDPOINT OAUTH2_ID_MAP OAUTH2_USERNAME_MAP OAUTH2_FULLNAME_MAP OAUTH2_ID_TOKEN_WHITELIST_FIELDS OAUTH2_EMAIL_MAP OAUTH2_REQUEST_PERMISSIONS OAUTH2_ADFS_ENABLED OAUTH2_B2C_ENABLED LDAP_ENABLE LDAP_PORT LDAP_HOST LDAP_AD_SIMPLE_AUTH LDAP_BASEDN LDAP_LOGIN_FALLBACK LDAP_RECONNECT LDAP_TIMEOUT LDAP_IDLE_TIMEOUT LDAP_CONNECT_TIMEOUT LDAP_AUTHENTIFICATION LDAP_AUTHENTIFICATION_USERDN LDAP_AUTHENTIFICATION_PASSWORD LDAP_LOG_ENABLED LDAP_BACKGROUND_SYNC LDAP_BACKGROUND_SYNC_INTERVAL LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS LDAP_ENCRYPTION LDAP_CA_CERT LDAP_REJECT_UNAUTHORIZED LDAP_USER_AUTHENTICATION LDAP_USER_AUTHENTICATION_FIELD LDAP_USER_SEARCH_FILTER LDAP_USER_SEARCH_SCOPE LDAP_USER_SEARCH_FIELD LDAP_SEARCH_PAGE_SIZE LDAP_SEARCH_SIZE_LIMIT LDAP_GROUP_FILTER_ENABLE LDAP_GROUP_FILTER_OBJECTCLASS LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT LDAP_GROUP_FILTER_GROUP_NAME LDAP_UNIQUE_IDENTIFIER_FIELD LDAP_UTF8_NAMES_SLUGIFY LDAP_USERNAME_FIELD LDAP_FULLNAME_FIELD LDAP_MERGE_EXISTING_USERS LDAP_SYNC_USER_DATA LDAP_SYNC_USER_DATA_FIELDMAP LDAP_SYNC_GROUP_ROLES LDAP_DEFAULT_DOMAIN LDAP_EMAIL_MATCH_ENABLE LDAP_EMAIL_MATCH_REQUIRE LDAP_EMAIL_MATCH_VERIFIED LDAP_EMAIL_FIELD LDAP_SYNC_ADMIN_STATUS LDAP_SYNC_ADMIN_GROUPS HEADER_LOGIN_ID HEADER_LOGIN_FIRSTNAME HEADER_LOGIN_LASTNAME HEADER_LOGIN_EMAIL LOGOUT_WITH_TIMER LOGOUT_IN LOGOUT_ON_HOURS LOGOUT_ON_MINUTES DEFAULT_AUTHENTICATION_METHOD PASSWORD_LOGIN_ENABLED CAS_ENABLED CAS_BASE_URL CAS_LOGIN_URL CAS_VALIDATE_URL SAML_ENABLED SAML_PROVIDER SAML_ENTRYPOINT SAML_ISSUER SAML_CERT SAML_IDPSLO_REDIRECTURL SAML_PRIVATE_KEYFILE SAML_PUBLIC_CERTFILE SAML_IDENTIFIER_FORMAT SAML_LOCAL_PROFILE_MATCH_ATTRIBUTE SAML_ATTRIBUTES ORACLE_OIM_ENABLED RESULTS_PER_PAGE WAIT_SPINNER NODE_OPTIONS"

DESCRIPTION_S3='AWS S3 for files. Example: {"s3":{"key": "xxx", "secret": "xxx", "bucket": "xxx", "region": "eu-west-1"}}'
DEFAULT_S3=""
KEY_S3="s3"

#-----------------------------------------------------------------
# ==== AWS S3 FOR FILES ====
# Any region. For example:
#   us-standard,us-west-1,us-west-2,
#   eu-west-1,eu-central-1,
#   ap-southeast-1,ap-northeast-1,sa-east-1
#
#- S3='{"s3":{"key": "xxx", "secret": "xxx", "bucket": "xxx", "region": "eu-west-1"}}'
#-----------------------------------------------------------------

This file has been truncated. show original

github.com

wekan/wekan/blob/main/snap-src/bin/wekan-help

#!/bin/bash

# first read settings
source $SNAP/bin/wekan-read-settings &>/dev/null
if [ "$CADDY_ENABLED" = "true" ]; then
    # tweak port nunmber as it has been remapped
    export PORT=${CADDY_PORT} &>/dev/null
fi

echo -e "Wekan: The open-source kanban.\n"
echo -e "\n"
echo -e "Debug OIDC OAuth2 etc."
echo -e "To enable the Debug of Wekan:"
echo -e "\t$ snap set $SNAP_NAME debug='true'"
echo -e "\t-Disable the Debug of Wekan:"
echo -e "\t$ snap unset $SNAP_NAME debug"
echo -e "\n"
echo -e "AWS S3 for files:"
echo -e "\t$ snap set $NAP_NAME s3='{\"s3\":{\"key\": \"xxx\", \"secret\": \"xxx\", \"bucket\": \"xxx\", \"region\": \"eu-west-1\"}}'"
echo -e "Disable S3:"

This file has been truncated. show original

github.com

wekan/wekan/blob/main/snapcraft.yaml

name: wekan
version: '7.24'
base: core20
summary: Open Source kanban
description: |
   WeKan ® is an Open Source and collaborative kanban board application.

   Whether you’re maintaining a personal todo list, planning your holidays with some friends, or working in a team on your next revolutionary idea, Kanban boards are an unbeatable tool to keep your things organized. They give you a visual overview of the current state of your project, and make you productive by allowing you to focus on the few items that matter the most.
   Depending on target environment, some configuration settings might need to be adjusted.
   For full list of configuration options call:
   $ wekan.help

confinement: strict
grade: stable

architectures:
  - amd64

plugs:
  mongodb-plug:

This file has been truncated. show original

Bash script for Source Bundle

github.com

wekan/wekan/blob/main/start-wekan.sh

#!/bin/bash

# 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
      #-----------------------------------------------------------------

This file has been truncated. show original

Bat script for Windows

github.com

wekan/wekan/blob/main/start-wekan.bat

@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://192.168.0.21

REM # Must change to YOUR-PORT-NUMBER:
SET PORT=80

This file has been truncated. show original

Some settings for Sandstorm

github.com

wekan/wekan/blob/main/sandstorm-pkgdef.capnp#L242


      
          argv = ["/sandstorm-http-bridge", "4000", "--", "node", "start.js"],
          environ = [
            # Note that this defines the *entire* environment seen by your app.
            #---------------------------------------------------------------------
            # https://github.com/wekan/wekan/issues/3585#issuecomment-1021522132
            # Add more Node heap:
            #export NODE_OPTIONS="--max_old_space_size=4096"
            # Add more stack:
            #bash -c "ulimit -s 65500; exec node --stack-size=65500 main.js"
            #---------------------------------------------------------------------
            (key = "NODE_OPTIONS", value = "--max_old_space_size=4096"),
            (key = "PATH", value = "/usr/local/bin:/usr/bin:/bin"),
            (key = "WRITABLE_PATH", value = "/var/wekan-uploads"),
            (key = "RESULTS_PER_PAGE", value = ""),
            (key = "WITH_API", value = "true"),
            (key = "RICHER_CARD_COMMENT_EDITOR", value="false"),
            (key = "CARD_OPENED_WEBHOOK_ENABLED", value="false"),
            (key = "NOTIFICATION_TRAY_AFTER_READ_DAYS_BEFORE_REMOVE", value=""),
            (key = "BIGEVENTS_PATTERN", value="NONE"),
            (key = "MATOMO_ADDRESS", value=""),
            (key = "MATOMO_SITE_ID", value=""),

How to use serverside environment variables at clientside/browserside

github.com

wekan/wekan/blob/main/server/header-login.js

Meteor.startup(() => {
  if (process.env.HEADER_LOGIN_ID) {
    Meteor.settings.public.headerLoginId        = process.env.HEADER_LOGIN_ID;
    Meteor.settings.public.headerLoginEmail     = process.env.HEADER_LOGIN_EMAIL;
    Meteor.settings.public.headerLoginFirstname = process.env.HEADER_LOGIN_FIRSTNAME;
    Meteor.settings.public.headerLoginLastname  = process.env.HEADER_LOGIN_LASTNAME;
  }
});

Admin Panel

Admin Panel web UI has some additional settings, that can be clicked.

1 Like