Personal server settings are stored in config.json
and are read when the server is launched. The contents are:
Key | Description | Example |
---|---|---|
serverRoot | Root URL of the server | http://localhost:8000 |
port | Server port | 8000 |
dbtype | Type of database. sqlite3 , postgres , or mysql |
sqlite3 |
dbconfig | Database connection string | postgres://user:pass@localhost/boards?sslmode=disable&connect_timeout=10 |
useSSL | Enable or disable SSL | false |
webpath | Path to web files | ./webapp/pack |
filespath | Path to uploaded files folder | ./files |
telemetry | Enable health diagnostics telemetry | true |
prometheus_address | Enables Prometheus metrics, if it’s empty is disabled | :9092 |
session_expire_time | Session expiration time in seconds | 2592000 |
session_refresh_time | Session refresh time in seconds | 18000 |
localOnly | Only allow connections from localhost | false |
enableLocalMode | Enable admin APIs on local Unix port | true |
localModeSocketLocation | Location of local Unix port | /var/tmp/focalboard_local.socket |
enablePublicSharedBoards | Enable publishing boards for public access | false |
By default, personal server exposes admin APIs on a local Unix socket at /var/tmp/focalboard_local.socket
. This is configurable using the enableLocalMode
and localModeSocketLocation
settings in config.json
.
Note that if you’re using a version of Mattermost Boards up to v7.1, you need to use v1 of the API. From v7.2 onwards, you need to use v2 of the API.
To reset a user’s password, you can use the following reset-password.sh
script:
#!/bin/bash
if [[ $# < 2 ]] ; then
echo 'reset-password.sh <username> <new password>'
exit 1
fi
curl --unix-socket /var/tmp/focalboard_local.socket http://localhost/api/v2/admin/users/$1/password -X POST -H 'Content-Type: application/json' -d '{ "password": "'$2'" }'
After resetting a user’s password (e.g. if they forgot it), direct them to change it from the user menu, by clicking on their username at the top of the sidebar.