focalboard/website/site/content/guide/admin/_index.md

46 lines
2 KiB
Markdown
Raw Normal View History

2021-01-25 20:08:42 +01:00
---
title: "Administrator's Guide"
date: "2020-12-15T12:01:23-04:00"
section: "guide"
weight: 3
---
2021-07-06 19:21:43 +02:00
## Personal server configuration
2021-01-25 20:08:42 +01:00
2021-07-06 19:21:43 +02:00
Personal server settings are stored in `config.json` and are read when the server is launched. The contents are:
2021-01-25 20:08:42 +01:00
| Key | Description | Example |
2021-07-06 19:21:43 +02:00
|----------|-------------|---------|
| 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`
| 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`
2021-01-25 20:08:42 +01:00
| session_expire_time | Session expiration time in seconds | 2592000
2021-07-06 19:21:43 +02:00
| 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`
2021-01-25 20:08:42 +01:00
## Resetting passwords
2021-07-06 19:21:43 +02:00
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`.
2021-01-25 20:08:42 +01:00
2021-02-01 19:31:06 +01:00
To reset a user's password, you can use the following `reset-password.sh` script:
2021-01-25 20:08:42 +01:00
```
#!/bin/bash
if [[ $# < 2 ]] ; then
echo 'reset-password.sh <username> <new password>'
exit 1
fi
2021-02-01 19:31:06 +01:00
curl --unix-socket /var/tmp/focalboard_local.socket http://localhost/api/v1/admin/users/$1/password -X POST -H 'Content-Type: application/json' -d '{ "password": "'$2'" }'
2021-01-25 20:08:42 +01:00
```
2021-01-27 22:08:25 +01:00
2021-07-06 19:21:43 +02:00
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.