diff options
Diffstat (limited to 'snap-src/bin/wekan-help')
| -rwxr-xr-x | snap-src/bin/wekan-help | 69 |
1 files changed, 68 insertions, 1 deletions
diff --git a/snap-src/bin/wekan-help b/snap-src/bin/wekan-help index ee565500..95814d36 100755 --- a/snap-src/bin/wekan-help +++ b/snap-src/bin/wekan-help @@ -7,7 +7,7 @@ if [ "$CADDY_ENABLED" = "true" ]; then export PORT=${CADDY_PORT} &>/dev/null fi -echo -e "Wekan: The open-source Trello-like kanban.\n" +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" @@ -28,6 +28,73 @@ 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" +echo -e "What to send to Outgoing Webhook, or leave out. Example, that includes all that are default: cardId,listId,oldListId,boardId,comment,user,card,commentId ." +echo -e "To enable the Webhooks Attributes of Wekan:" +echo -e "\t$ snap set $SNAP_NAME WEBHOOKS_ATTRIBUTES='cardId,listId,oldListId,boardId,comment,user,card,commentId'" +echo -e "\t-Disable the Webhooks Attributes of Wekan to send all default ones:" +echo -e "\t$ snap set $SNAP_NAME WEBHOOKS_ATTRIBUTES=''" +echo -e "\n" +echo -e "OAuth2 Client ID, for example from Rocket.Chat. Example: abcde12345" +echo -e "To enable the OAuth2 Client ID of Wekan:" +echo -e "\t$ snap set $SNAP_NAME OAUTH2_CLIENT_ID='54321abcde'" +echo -e "\t-Disable the OAuth2 Client ID of Wekan:" +echo -e "\t$ snap set $SNAP_NAME OAUTH2_CLIENT_ID=''" +echo -e "\n" +echo -e "OAuth2 Secret, for example from Rocket.Chat. Example: 54321abcde" +echo -e "To enable the OAuth2 Secret of Wekan:" +echo -e "\t$ snap set $SNAP_NAME OAUTH2_SECRET='54321abcde'" +echo -e "\t-Disable the OAuth2 Secret of Wekan:" +echo -e "\t$ snap set $SNAP_NAME OAUTH2_SECRET=''" +echo -e "\n" +echo -e "OAuth2 Server URL, for example Rocket.Chat. Example: https://chat.example.com" +echo -e "To enable the OAuth2 Server URL of Wekan:" +echo -e "\t$ snap set $SNAP_NAME OAUTH2_SERVER_URL='https://chat.example.com'" +echo -e "\t-Disable the OAuth2 Server URL of Wekan:" +echo -e "\t$ snap set $SNAP_NAME OAUTH2_SERVER_URL=''" +echo -e "\n" +echo -e "OAuth2 Server URL, for example Rocket.Chat. Example: https://chat.example.com" +echo -e "To enable the OAuth2 Server URL of Wekan:" +echo -e "\t$ snap set $SNAP_NAME OAUTH2_SERVER_URL='https://chat.example.com'" +echo -e "\t-Disable the OAuth2 Server URL of Wekan:" +echo -e "\t$ snap set $SNAP_NAME OAUTH2_SERVER_URL=''" +echo -e "\n" +echo -e "OAuth2 Authorization Endpoint. Example: /oauth/authorize" +echo -e "To enable the OAuth2 Authorization Endpoint of Wekan:" +echo -e "\t$ snap set $SNAP_NAME OAUTH2_AUTH_ENDPOINT='/oauth/authorize'" +echo -e "\t-Disable the OAuth2 Authorization Endpoint of Wekan:" +echo -e "\t$ snap set $SNAP_NAME OAUTH2_AUTH_ENDPOINT=''" +echo -e "\n" +echo -e "OAuth2 Userinfo Endpoint. Example: /oauth/userinfo" +echo -e "To enable the OAuth2 Userinfo Endpoint of Wekan:" +echo -e "\t$ snap set $SNAP_NAME OAUTH2_USERINFO_ENDPOINT='/oauth/authorize'" +echo -e "\t-Disable the OAuth2 Userinfo Endpoint of Wekan:" +echo -e "\t$ snap set $SNAP_NAME OAUTH2_USERINFO_ENDPOINT=''" +echo -e "\n" +echo -e "OAuth2 Token Endpoint. Example: /oauth/token" +echo -e "To enable the OAuth2 Token Endpoint of Wekan:" +echo -e "\t$ snap set $SNAP_NAME OAUTH2_TOKEN_ENDPOINT='/oauth/token'" +echo -e "\t-Disable the OAuth2 Token Endpoint of Wekan:" +echo -e "\t$ snap set $SNAP_NAME OAUTH2_TOKEN_ENDPOINT=''" +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>'" |