summaryrefslogtreecommitdiff
path: root/doc/sharing-projects.markdown
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-08-29 20:00:53 -0400
committerFrederic Guillot <fred@kanboard.net>2015-08-29 20:00:53 -0400
commit6c711f696f73bc59813f6834ec241aef3b626cbd (patch)
treeded4f0e8c7f8c672414ff3f2f84eac0f6d9073e5 /doc/sharing-projects.markdown
parentef087f5e22df1a0d97babef26aaf9b8960ee6d5d (diff)
Include documentation in the application
Diffstat (limited to 'doc/sharing-projects.markdown')
-rw-r--r--doc/sharing-projects.markdown35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/sharing-projects.markdown b/doc/sharing-projects.markdown
new file mode 100644
index 00000000..3e72071b
--- /dev/null
+++ b/doc/sharing-projects.markdown
@@ -0,0 +1,35 @@
+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)
+
+When the public access is enabled, a couple of links are generated:
+
+- Public board view
+- RSS feed subscription link
+- iCalendar subscription link
+
+![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 previous links will not work anymore.