71fe928dd2
* Update _index.md * Adding Mysql to Ubuntu.md and Personal Server configuration * Update website/site/content/guide/admin/_index.md Co-authored-by: Jesús Espino <jespinog@gmail.com> * removed typo Unneeded 16) * Fixing error * Update _index.md In-doc editing for formatting and style. * Update website/site/content/download/personal-edition/ubuntu.md LGTM Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com> * Update website/site/content/download/personal-edition/ubuntu.md LGTM Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com> * Update website/site/content/download/personal-edition/ubuntu.md LGTM Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com> * Update website/site/content/download/personal-edition/ubuntu.md LGTM Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com> * Update website/site/content/download/personal-edition/ubuntu.md Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com> * replacing <pre> replacing <pre> with ``` * Removed the last <pre> Thank you @jespino for noticing the last <pre> * Update ubuntu.md Reviewed the code samples and added additional backticks. Also added linebreaks. * Update _index.md Minor addition: oxford comma in table. Co-authored-by: Tom De Moor <tom@controlaltdieliet.be> Co-authored-by: Jesús Espino <jespinog@gmail.com> Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com>
45 lines
2 KiB
Markdown
45 lines
2 KiB
Markdown
---
|
|
title: "Administrator's Guide"
|
|
date: "2020-12-15T12:01:23-04:00"
|
|
section: "guide"
|
|
weight: 3
|
|
---
|
|
|
|
## Personal server configuration
|
|
|
|
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`
|
|
| 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`
|
|
|
|
## Resetting passwords
|
|
|
|
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`.
|
|
|
|
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/v1/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.
|