mirror of
https://github.com/mattermost/focalboard.git
synced 2024-12-24 13:43:12 +02:00
Update website for v0.9.2 (#1534)
This commit is contained in:
Chen-I Lim
GitHub
parent
cad6884fda
commit
341febe84a
@ -5,72 +5,21 @@ section: "download"
|
||||
weight: 2
|
||||
---
|
||||
|
||||
Focalboard is now integrated with Mattermost v5.36 and later.
|
||||
Focalboard is installed with Mattermost v6.0, where is it named Boards. Install or upgrade to Mattermost v6.0 or later, click on the menu at the top left, and select Boards to open it.
|
||||
|
||||
## Enable Focalboard plugin
|
||||
No additional server or web-proxy configuration is required.
|
||||
|
||||
To enable Focalboard, open your Mattermost instance, then:
|
||||
### Enable Shared Boards
|
||||
|
||||
1. Go to **Main Menu > Marketplace**.
|
||||
2. Search for "Focalboard".
|
||||
3. Install the Focalboard plugin.
|
||||
4. Select **Configure** and enable the plugin.
|
||||
5. Select **Save**.
|
||||
The shared boards feature is disabled by default in Mattermost. To enable it:
|
||||
|
||||
The Focalboard plugin requires websocket traffic to be passed by the proxy. Update your NGINX or Apache web proxy config following the steps below.
|
||||
1. Open the System Console
|
||||
2. Select Mattermost Boards under Plugins
|
||||
3. Turn on the setting for "Enable Publicly-Shared Boards"
|
||||
|
||||
### With NGINX
|
||||
### Permissions
|
||||
|
||||
After following the standard [Mattermost install steps](https://docs.mattermost.com/install/installing-ubuntu-1804-LTS.html#configuring-nginx-as-a-proxy-for-mattermost-server), edit `/etc/nginx/sites-available/mattermost` and add this section to it:
|
||||
|
||||
```
|
||||
location ~ /plugins/focalboard/ws/* {
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection "upgrade";
|
||||
client_max_body_size 50M;
|
||||
proxy_set_header Host $http_host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_set_header X-Frame-Options SAMEORIGIN;
|
||||
proxy_buffers 256 16k;
|
||||
proxy_buffer_size 16k;
|
||||
client_body_timeout 60;
|
||||
send_timeout 300;
|
||||
lingering_timeout 5;
|
||||
proxy_connect_timeout 90;
|
||||
proxy_send_timeout 300;
|
||||
proxy_read_timeout 90s;
|
||||
proxy_pass http://backend;
|
||||
}
|
||||
```
|
||||
|
||||
Restart NGINX with `sudo systemctl restart nginx`.
|
||||
|
||||
### With Apache (unofficial)
|
||||
|
||||
After following the [install guide for Apache and Mattermost](https://docs.mattermost.com/configure/configuring-apache2.html#configuring-apache2-as-a-proxy-for-mattermost-server-unofficial), modify the web sockets section in `/etc/apache2/sites-available` as follows:
|
||||
|
||||
```
|
||||
# Set web sockets
|
||||
RewriteEngine On
|
||||
RewriteCond %{REQUEST_URI} /api/v[0-9]+/(users/)?websocket|/plugins/focalboard/ws/* [NC,OR]
|
||||
RewriteCond %{HTTP:UPGRADE} ^WebSocket$ [NC,OR]
|
||||
RewriteCond %{HTTP:CONNECTION} ^Upgrade$ [NC]
|
||||
RewriteRule .* ws://127.0.0.1:8065%{REQUEST_URI} [P,QSA,L]
|
||||
```
|
||||
|
||||
Restart Apache with `sudo systemctl restart apache2`
|
||||
|
||||
## Accessing Focalboard from Mattermost
|
||||
|
||||
<img src='https://user-images.githubusercontent.com/46905241/121930013-bbd12880-ccf6-11eb-9647-c9e367690111.png' style='max-height: 50px' />
|
||||
|
||||
In Mattermost, select the Focalboard icon in the channel header to access boards for that channel.
|
||||
|
||||
### Focalboard Permissions
|
||||
|
||||
Focalboard currently uses channel-based permissions, meaning that only members of the associated channel can access (read / write) the boards for that channel.
|
||||
Mattermost Boards currently uses channel-based permissions, meaning that only members of the associated channel can access (read / write) the boards for that channel.
|
||||
|
||||
You can use this to create private boards:
|
||||
1. Create or join a private channel (or group channel or direct-message)
|
||||
@ -80,3 +29,5 @@ You can use this to create private boards:
|
||||
Only members of that private channel can access the board.
|
||||
|
||||
You can use the [share board](/guide/user/#sharing-boards) feature to share a read-only board with anyone (incuding unauthenticated users) who has the generated link.
|
||||
|
||||
For more information of using Mattermost Boards, refer to the main [product documentation here](https://docs.mattermost.com/guides/boards.html).
|
||||
|
||||
@ -13,7 +13,7 @@ Follow the steps in the [Mattermost admin guide to enable custom plugins](https:
|
||||
1. Manually set `PluginSettings > EnableUploads` to `true` in your `config.json`
|
||||
2. Restart the Mattermost server
|
||||
|
||||
Download `mattermost-plugin-focalboard.tar.gz` from the build or release, e.g. the [Focalboard 0.7.3 release](https://github.com/mattermost/focalboard/releases/tag/v0.7.3).
|
||||
Download `mattermost-plugin-focalboard.tar.gz` from the latest build or [release](https://github.com/mattermost/focalboard/releases).
|
||||
|
||||
Then upload the Focalboard plugin:
|
||||
1. Navigate to **System Console > Plugins > Plugin Management**
|
||||
|
||||
@ -12,8 +12,8 @@ Use the URL of the Ubuntu archive package, `focalboard-server-linux-amd64.tar.gz
|
||||
Create and use a clean directory, or delete any existing packages first, then run:
|
||||
|
||||
```
|
||||
# Download the new version (e.g. 0.7.0 here, check the release for the latest one)
|
||||
wget https://github.com/mattermost/focalboard/releases/download/v0.7.0/focalboard-server-linux-amd64.tar.gz
|
||||
# Download the new version (e.g. 0.9.2 here, check the release for the latest one)
|
||||
wget https://github.com/mattermost/focalboard/releases/download/v0.9.2/focalboard-server-linux-amd64.tar.gz
|
||||
tar -xvzf focalboard-server-linux-amd64.tar.gz
|
||||
|
||||
# Stop the server
|
||||
|
||||
@ -17,10 +17,10 @@ Popular hosted options include:
|
||||
|
||||
## Install Focalboard
|
||||
|
||||
Download the Ubuntu archive package from the appropriate [release in GitHub](https://github.com/mattermost/focalboard/releases). E.g. this is the link for v0.7.0 (which may no longer be the latest one):
|
||||
Download the Ubuntu archive package from the appropriate [release in GitHub](https://github.com/mattermost/focalboard/releases). E.g. this is the link for v0.9.2 (which may no longer be the latest one):
|
||||
|
||||
```
|
||||
wget https://github.com/mattermost/focalboard/releases/download/v0.7.0/focalboard-server-linux-amd64.tar.gz
|
||||
wget https://github.com/mattermost/focalboard/releases/download/v0.9.2/focalboard-server-linux-amd64.tar.gz
|
||||
tar -xvzf focalboard-server-linux-amd64.tar.gz
|
||||
sudo mv focalboard /opt
|
||||
```
|
||||
@ -197,7 +197,7 @@ Change the dbconfig setting to use the MySQL database you created:
|
||||
|
||||
When MySQL is being used, using collation is recommended over using charset.
|
||||
|
||||
Using a variant of `utf8mb4` collation is required. For example, `utf8mb4_general_ci`
|
||||
Using a variant of `utf8mb4` collation is required. For example, `utf8mb4_general_ci`
|
||||
is used by default when no collation is specified.
|
||||
|
||||
If you're using Focalboard as a Mattermost Plugin prior to version 0.9 with MySQL,
|
||||
|
||||
Loading…
Reference in New Issue
Block a user