diff options
author | Frédéric Guillot <fred@kanboard.net> | 2014-09-18 19:32:22 +0200 |
---|---|---|
committer | Frédéric Guillot <fred@kanboard.net> | 2014-09-18 19:32:22 +0200 |
commit | 7fac9783c6593f89266e6d152faeb2aef09b6dfc (patch) | |
tree | 7e762f3ed1be1c7ecf1bed2348775bd52f19f5d1 | |
parent | 7e6d35f829d63ce08f600d5d207b55244a16bdb3 (diff) |
Add documentation about board public access
-rw-r--r-- | README.markdown | 1 | ||||
-rw-r--r-- | docs/sharing-projects.markdown | 31 |
2 files changed, 32 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown index 07d0aadf..5f526bad 100644 --- a/README.markdown +++ b/README.markdown @@ -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 diff --git a/docs/sharing-projects.markdown b/docs/sharing-projects.markdown new file mode 100644 index 00000000..8671bfd5 --- /dev/null +++ b/docs/sharing-projects.markdown @@ -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. |