Add documentation about board public access

This commit is contained in:
Frédéric Guillot 2014-09-18 19:32:22 +02:00
parent 7e6d35f829
commit 7fac9783c6
2 changed files with 32 additions and 0 deletions

View File

@ -55,6 +55,7 @@ Documentation
#### Working with projects
- [Creating projects](docs/creating-projects.markdown)
- [Sharing boards and tasks](docs/sharing-projects.markdown)
- [Automatic actions](docs/automatic-actions.markdown)
#### Working with tasks

View File

@ -0,0 +1,31 @@
Sharing boards and tasks
========================
By default, boards are private but it's possible to make a board public.
A public board can't be modified, it's a **read-only access**.
This access is protected by a random token, only people who have the right token can see the board.
Public boards are automatically refreshed every 60 seconds.
Task details are also available in read-only.
Usage examples:
- Share your board with someone outside of your organization
- Display the board on a large screen in your office
Enable public access
-------------------
Select your project, then click on "Public access" and finally click on the button "Enable public access".
![Enable public access](http://kanboard.net/screenshots/documentation/project-enable-sharing.png)
After that, you got the public link and the RSS feed.
The activity feed is available only when the public access is activated.
![Disable public access](http://kanboard.net/screenshots/documentation/project-disable-sharing.png)
You can also disable the public access whenever you want.
Each time, you enable or disable the public access a new random token is generated.
The old link will not work anymore.