mirror of https://github.com/wekan/wekan
The Open Source kanban (built with Meteor). Keep variable/table/field names camelCase. For translations, only add Pull Request changes to wekan/i18n/en.i18n.json , other translations are done at https://transifex.com/wekan/wekan only.
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
67 lines
3.4 KiB
67 lines
3.4 KiB
#!/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 "Make sure you have connected all interfaces, check more by calling $ snap interfaces ${SNAP_NAME}"
|
|
echo -e "\n"
|
|
echo -e "${SNAP_NAME} has multiple services, to check status use systemctl"
|
|
echo -e "\t$ systemctl status snap.$SNAP_NAME.*"
|
|
echo -e "\n"
|
|
echo -e "To make backup of wekan's database use: $ ${SNAP_NAME}.database-backup [backup file]"
|
|
echo -e "\t backup file is optional parameter, if not passed backup is created in directory:"
|
|
echo -e "\t\t${SNAP_COMMON}/db-backups"
|
|
echo -e "To list existing backups in default directory: $ ${SNAP_NAME}.database-list-backups"
|
|
echo -e "To restore wekan's database use: ${SNAP_NAME}.database-restore <path to backup>"
|
|
echo -e "\n"
|
|
echo -e "wekan can be configured to share mongodb with other services using content interface"
|
|
echo -e "\t-sharing mongodb from $SNAP_NAME to other snap(s):"
|
|
echo -e "\t\t-connect mongodb-slot with plug from corresponding snap(s)"
|
|
echo -e "\t\t-configure corresponding service to use mongodb unix socket in shared directory, socket file name is: mongodb-$MONGODB_PORT.sock"
|
|
echo -e "\t-sharing mongodb from other snap to $SNAP_NAME:"
|
|
echo -e "\t\t-connect mongodb-plug with slot from snap providing mongodb"
|
|
echo -e "\t\t-disable mongodb in $SNAP_NAME by calling: $ snap set $SNAP_NAME set disable-mongodb='true'"
|
|
echo -e "\t\t-set mongodb-bind-unix-socket to point to serving mongodb. Use relative path inside shared directory, e.g run/mongodb-27017.sock"
|
|
echo -e "\n"
|
|
echo -e "To enable the API of wekan:"
|
|
echo -e "\t$ snap set $SNAP_NAME WITH_API='true'"
|
|
echo -e "\t-Disable the API:"
|
|
echo -e "\t$ snap set $SNAP_NAME WITH_API='false'"
|
|
echo -e "\n"
|
|
echo -e "Enable browser policy and allow one trusted URL that can have iframe that has Wekan embedded inside."
|
|
echo -e "\t\t Setting this to false is not recommended, it also disables all other browser policy protections"
|
|
echo -e "\t\t and allows all iframing etc. See wekan/server/policy.js"
|
|
echo -e "To enable the Content Policy of Wekan:"
|
|
echo -e "\t$ snap set $SNAP_NAME CONTENT_POLICY_ENABLED='true'"
|
|
echo -e "\t-Disable the Content Policy of Wekan:"
|
|
echo -e "\t$ snap set $SNAP_NAME CONTENT_POLICY_ENABLED='false'"
|
|
echo -e "\n"
|
|
echo -e "When browser policy is enabled, HTML code at this URL can have iframe that embeds Wekan inside."
|
|
echo -e "To enable the Trusted URL of Wekan:"
|
|
echo -e "\t$ snap set $SNAP_NAME TRUSTED_URL='https://example.com'"
|
|
echo -e "\t-Disable the Trusted URL of Wekan:"
|
|
echo -e "\t$ snap set $SNAP_NAME TRUSTED_URL=''"
|
|
echo -e "\n"
|
|
# parse config file for supported settings keys
|
|
echo -e "wekan supports settings keys"
|
|
echo -e "values can be changed by calling\n$ snap set $SNAP_NAME <key name>='<key value>'"
|
|
echo -e "list of supported keys:"
|
|
for key in ${keys[@]}
|
|
do
|
|
default_value="DEFAULT_$key"
|
|
description="DESCRIPTION_$key"
|
|
snappy_key="KEY_$key"
|
|
echo -e "\t${!snappy_key}: ${!description}"
|
|
if [ "x" == "x${!key}" ]; then
|
|
echo -e "\t\tNo value set, using default value: '${!default_value}'"
|
|
else
|
|
echo -e "\t\tCurrent value set to: '${!key}', (default value: '${!default_value}')"
|
|
fi
|
|
done
|
|
|
|
echo -e "\n!!!! Some changes result in restart of some or all services, use with caution !!!!!"
|
|
|