Fossil SCM

More feature rah-rah in www/forum.wiki, plus better formatting.

wyoung 2018-08-09 06:04 trunk
Commit cce5da1658e6ef90bb1c38beea4cd01fb5cdde6bb639ed760981234427eb3c9d
1 file changed +117 -78
+117 -78
--- www/forum.wiki
+++ www/forum.wiki
@@ -2,88 +2,127 @@
22
33
<h2>Introduction</h2>
44
55
As of Fossil 2.7, Fossil includes a built-in discussion forum feature.
66
7
-Any project complex enough to be managed by Fossil can probably benefit
8
-from having a discussion forum. Even if your project has a discussion
9
-forum already, there are further benefits that stem from using Fossil's
10
-built-in forum feature:
11
-
12
- * Third-party discussion forum and mailing list software tends to be
13
- difficult to install, set up, and administer. Fossil Forums aim to
14
- be as close to zero-configuration as is practical.
15
-
16
- * Posts are stored in the Fossil repository using the same
17
- [./fileformat.wiki | block chain technology] that Fossil uses to
18
- store your check-ins, wiki documents, etc. Posts sync to cloned
19
- repositories in a tamper-proof fashion.
20
-
21
- * Because of Fossil's [./delta_format.wiki | delta compression
22
- technology], discussions add little to the size of a cloned
23
- repository. Ten years of the SQLite project's discussions —
24
- averaging 2 or 3 dozen posts per day — compress down to just
25
- 35&nbsp;MB of space in a Fossil Forums repository.
26
-
27
- * Fossil Forums use [https://sqlite.org/fts3.html | SQLite's powerful
28
- FTS4 full-text search engine]. If your project currently uses a
29
- mailing list for discussions, this means you are no longer reliant
30
- upon third-party mailing list archive services to provide a useful
31
- search engine for your discussions.
32
-
33
- * Because Fossil is a [./concepts.wiki | distributed version control
34
- system], project members can search your forum archive while
35
- disconnected from the network where the central Fossil instance
36
- runs. Your past discussions are potentially just as valuable as a
37
- wiki document or checkin comment: there is no good reason why you
38
- should have to wait to get back on the Internet or back to the
39
- office before you can search for past posts.
40
-
41
- * When you search the forum archives via the Fossil web interface,
42
- you get only one result for each matching post. When you search a
43
- mailing list's archives using a standard web search engine, you
44
- might get a result from the project site's own mail archive plus
45
- one from Nabble, one from Gmane, one from The Mail Archive...
46
-
47
- * Because forum posts are normal Fossil artifacts, you can interlink
48
- them with other Fossil artifacts using short internal links: link
49
- to forum threads from a [./tickets.wiki | ticket], link to a wiki
50
- document from a forum post, etc. These links are internal and
51
- managed by Fossil itself, so links never become invalid simply
52
- because your third-party forum software or mailing list search
53
- engine changed its URL scheme.
54
-
55
- * The forum uses the same role-based access control mechanism as
56
- Fossil uses for all other accesses.
57
-
58
- * Since Fossil has an [./fileformat.wiki | open and well-documented
59
- file format], your discussion archives are truly that:
60
- <em>archives</em>. You are no longer dependent on a third-party
61
- piece of software or service sticking around. Should you choose to
62
- stop using Fossil, you can easily extract your discussion traffic
63
- for transfer to another system.
64
-
65
- * Posts can be marked up using Fossil's existing [/md_rules |
66
- Markdown] and [/wiki_rules | Wiki] markup languages. No longer must
67
- you choose to restrict your discussion forums to plain text only
68
- (good for security) or to allow HTML-formatted MIME email (good for
69
- complex discussions). Fossil Forums provide <em>enough</em>
70
- formatting without giving up security.
71
-
72
- * Fossil forums integrate with third-party
73
- [https://en.wikipedia.org/wiki/Message_transfer_agent | message transfer agents]
74
- such as Postfix, Exim, and Sendmail. If you've got mail service
75
- configured on the server hosting your Fossil instance, it can send
76
- notifications of new posts to interested forum users, complete with
77
- message content for those that prefer to visit the forum only when
78
- they need to post something.
79
-
80
- * Because Fossil accepts forum posts only via the web UI, it is
81
- inherently [./antibot.wiki | protected against bots].
82
-
83
-
84
-<h2>Setting up a Fossil Forum</h2>
7
+Any project complex enough to benefit from being managed by Fossil and
8
+which has more than one user can probably also benefit from having a
9
+discussion forum. Even if your project has a discussion forum already,
10
+there are many benefits to using Fossil's built-in forum feature, some
11
+of which you cannot get by using third-party alternatives:
12
+
13
+ * <b>Easy to administer:</b> Third-party discussion forum and mailing
14
+ list software tends to be difficult to install, set up, and
15
+ administer. The Fossil forum feature aims to be as close to
16
+ zero-configuration as is practical.
17
+
18
+ * <b>Malefactor resistant:</b> Because Fossil accepts forum posts
19
+ only via the web UI, it is inherently [./antibot.wiki | protected
20
+ against bots].
21
+
22
+ * <b>Distributed and Tamper-Proof:</b> Posts are stored in the Fossil
23
+ repository using the same [./fileformat.wiki | block chain technology]
24
+ that Fossil uses to store your check-ins, wiki documents, etc.
25
+ Posts sync to cloned repositories in a tamper-proof fashion.
26
+
27
+ * <b>Space Efficient:</b> Because of Fossil's [./delta_format.wiki |
28
+ delta compression technology], discussions add little to the size
29
+ of a cloned repository. Ten years of the SQLite project's
30
+ discussions — averaging about 2 dozen posts per day — compress down
31
+ to [/forumpost/9b6f3f36bdb | just 35&nbsp;MB of space] in a Fossil
32
+ forum repository.
33
+
34
+ * <b>Built-in Full-Text Search:</b> Fossil forums use
35
+ [https://sqlite.org/fts3.html | SQLite's powerful FTS4 engine] to
36
+ handle searches. If your project currently uses a mailing list for
37
+ discussions, this means you are no longer reliant upon third-party
38
+ mailing list archive services to provide a useful search engine for
39
+ your discussions. If you are running a private Fossil repository,
40
+ you may not even have the <em>option</em> of delegating this useful
41
+ service to a third-party; Fossil provides this service out of the
42
+ box.
43
+
44
+ * <b>One Result Per Matching Post:</b> When you search the forum
45
+ archives via the Fossil web interface, you get only one result for
46
+ each matching post. When you search for project information via a
47
+ standard web search engine, you might get a result from the project
48
+ site's own mail archive plus one from Nabble, one from Gmane, one
49
+ from The Mail Archive...
50
+
51
+ * <b>Search Off-Line:</b> Because Fossil is a [./concepts.wiki |
52
+ distributed version control system], project members can search
53
+ your forum archive while disconnected from the network where the
54
+ central Fossil instance runs. Your past discussions are potentially
55
+ just as valuable as a wiki document or checkin comment: there is no
56
+ good reason why you should have to wait to get back on the Internet
57
+ or back to the office before you can search for past posts.
58
+
59
+ * <b>Contribute Off-Line:</b> Fossil forum posts work like any other
60
+ insertion into the repository, so a user can create new threads and
61
+ reply to existing ones while off-line, then sync their
62
+ contributions to the server they cloned from when back on-line.
63
+ Yes, you can post to the forum from inside a tent, miles from the
64
+ nearest wifi router or cellular data tower.
65
+
66
+ * <b>Interlink with Other Fossil-Managed Artifacts:</b> Because forum
67
+ posts are normal Fossil artifacts, you can interlink them with
68
+ other Fossil artifacts using short internal links: link to forum
69
+ threads from a [./tickets.wiki | ticket], link to a wiki document
70
+ from a forum post, etc.
71
+
72
+ * <b>Durable Links:</b> Once you create a valid internal artifact
73
+ link in Fossil, it <em>remains</em> valid, durably. With
74
+ third-party forum software and mailing list search engines, your
75
+ links are only valid until the third-party component changes its
76
+ URL scheme or disappears from the web.
77
+
78
+ * <b>Role-Based Access Control:</b> The forum uses the same
79
+ [https://en.wikipedia.org/wiki/Role-based_access_control | RBAC
80
+ system] that Fossil uses to control all other repository accesses.
81
+ The Fossil forum feature simply adds several new fine-grained
82
+ capability bits to the existing system.
83
+
84
+ * <b>Enduring, Open File Format:</b> Since Fossil has an
85
+ [./fileformat.wiki | open and well-documented file format], your
86
+ discussion archives are truly that: <em>archives</em>. You are no
87
+ longer dependent on the lifetime and business model of a
88
+ third-party piece of software or service. Should you choose to stop
89
+ using Fossil, you can easily extract your discussion traffic for
90
+ transfer to another system.
91
+
92
+ * <b>Lightweight Markup:</b> Posts can be marked up using Fossil's
93
+ existing [/md_rules | Markdown] and [/wiki_rules | Wiki] markup
94
+ processors. No longer must you choose between two bad options: to
95
+ restrict posts to plain text only or to allow wild-west
96
+ HTML-formatted MIME email. Fossil's lightweight markup language
97
+ formatting features give you a middle path, providing your users
98
+ enough formatting power to communicate complex ideas well without
99
+ providing so much power as to risk
100
+ [https://wonko.com/post/html-escaping | security problems].
101
+
102
+ * <b>Easy Notification Emails:</b> Fossil's forum feature integrates
103
+ with popular [https://en.wikipedia.org/wiki/Message_transfer_agent
104
+ | message transfer agents] (MTAs) such as Postfix, Exim, and
105
+ Sendmail. It is easy to configure Fossil to send notifications of
106
+ new posts to interested forum users via your Fossil server's
107
+ existing MTA. Notification emails include the complete message
108
+ content for the benefit of those that prefer to visit the forum
109
+ only when they need to post something.
110
+
111
+ * <b>Talks to Everyone:</b> Because Fossil delegates email handling
112
+ to your existing MTA, it does not need to implement the
113
+ [http://sqlite.1065341.n5.nabble.com/Many-ML-emails-going-to-GMail-s-SPAM-tp98685p98722.html
114
+ | roughly two dozen]
115
+ [https://en.wikipedia.org/wiki/Request_for_Comments | RFCs] needed
116
+ to properly support SMTP email in this complex world we've built.
117
+ As well, this design choice means you do not need to do duplicate
118
+ configuration, such as to point Fossil at your server's TLS
119
+ certificate private key in order to support users behind mail
120
+ servers that require STARTTLS encryption.
121
+
122
+
123
+<h2>Setting up aFossil Forum</h2>
85124
86125
<h3>Permissions</h3>
87126
88127
Fossil forums use the same role-based access control mechanism as
89128
for normal Fossil repository logins.
90129
--- www/forum.wiki
+++ www/forum.wiki
@@ -2,88 +2,127 @@
2
3 <h2>Introduction</h2>
4
5 As of Fossil 2.7, Fossil includes a built-in discussion forum feature.
6
7 Any project complex enough to be managed by Fossil can probably benefit
8 from having a discussion forum. Even if your project has a discussion
9 forum already, there are further benefits that stem from using Fossil's
10 built-in forum feature:
11
12 * Third-party discussion forum and mailing list software tends to be
13 difficult to install, set up, and administer. Fossil Forums aim to
14 be as close to zero-configuration as is practical.
15
16 * Posts are stored in the Fossil repository using the same
17 [./fileformat.wiki | block chain technology] that Fossil uses to
18 store your check-ins, wiki documents, etc. Posts sync to cloned
19 repositories in a tamper-proof fashion.
20
21 * Because of Fossil's [./delta_format.wiki | delta compression
22 technology], discussions add little to the size of a cloned
23 repository. Ten years of the SQLite project's discussions —
24 averaging 2 or 3 dozen posts per day — compress down to just
25 35&nbsp;MB of space in a Fossil Forums repository.
26
27 * Fossil Forums use [https://sqlite.org/fts3.html | SQLite's powerful
28 FTS4 full-text search engine]. If your project currently uses a
29 mailing list for discussions, this means you are no longer reliant
30 upon third-party mailing list archive services to provide a useful
31 search engine for your discussions.
32
33 * Because Fossil is a [./concepts.wiki | distributed version control
34 system], project members can search your forum archive while
35 disconnected from the network where the central Fossil instance
36 runs. Your past discussions are potentially just as valuable as a
37 wiki document or checkin comment: there is no good reason why you
38 should have to wait to get back on the Internet or back to the
39 office before you can search for past posts.
40
41 * When you search the forum archives via the Fossil web interface,
42 you get only one result for each matching post. When you search a
43 mailing list's archives using a standard web search engine, you
44 might get a result from the project site's own mail archive plus
45 one from Nabble, one from Gmane, one from The Mail Archive...
46
47 * Because forum posts are normal Fossil artifacts, you can interlink
48 them with other Fossil artifacts using short internal links: link
49 to forum threads from a [./tickets.wiki | ticket], link to a wiki
50 document from a forum post, etc. These links are internal and
51 managed by Fossil itself, so links never become invalid simply
52 because your third-party forum software or mailing list search
53 engine changed its URL scheme.
54
55 * The forum uses the same role-based access control mechanism as
56 Fossil uses for all other accesses.
57
58 * Since Fossil has an [./fileformat.wiki | open and well-documented
59 file format], your discussion archives are truly that:
60 <em>archives</em>. You are no longer dependent on a third-party
61 piece of software or service sticking around. Should you choose to
62 stop using Fossil, you can easily extract your discussion traffic
63 for transfer to another system.
64
65 * Posts can be marked up using Fossil's existing [/md_rules |
66 Markdown] and [/wiki_rules | Wiki] markup languages. No longer must
67 you choose to restrict your discussion forums to plain text only
68 (good for security) or to allow HTML-formatted MIME email (good for
69 complex discussions). Fossil Forums provide <em>enough</em>
70 formatting without giving up security.
71
72 * Fossil forums integrate with third-party
73 [https://en.wikipedia.org/wiki/Message_transfer_agent | message transfer agents]
74 such as Postfix, Exim, and Sendmail. If you've got mail service
75 configured on the server hosting your Fossil instance, it can send
76 notifications of new posts to interested forum users, complete with
77 message content for those that prefer to visit the forum only when
78 they need to post something.
79
80 * Because Fossil accepts forum posts only via the web UI, it is
81 inherently [./antibot.wiki | protected against bots].
82
83
84 <h2>Setting up a Fossil Forum</h2>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
85
86 <h3>Permissions</h3>
87
88 Fossil forums use the same role-based access control mechanism as
89 for normal Fossil repository logins.
90
--- www/forum.wiki
+++ www/forum.wiki
@@ -2,88 +2,127 @@
2
3 <h2>Introduction</h2>
4
5 As of Fossil 2.7, Fossil includes a built-in discussion forum feature.
6
7 Any project complex enough to benefit from being managed by Fossil and
8 which has more than one user can probably also benefit from having a
9 discussion forum. Even if your project has a discussion forum already,
10 there are many benefits to using Fossil's built-in forum feature, some
11 of which you cannot get by using third-party alternatives:
12
13 * <b>Easy to administer:</b> Third-party discussion forum and mailing
14 list software tends to be difficult to install, set up, and
15 administer. The Fossil forum feature aims to be as close to
16 zero-configuration as is practical.
17
18 * <b>Malefactor resistant:</b> Because Fossil accepts forum posts
19 only via the web UI, it is inherently [./antibot.wiki | protected
20 against bots].
21
22 * <b>Distributed and Tamper-Proof:</b> Posts are stored in the Fossil
23 repository using the same [./fileformat.wiki | block chain technology]
24 that Fossil uses to store your check-ins, wiki documents, etc.
25 Posts sync to cloned repositories in a tamper-proof fashion.
26
27 * <b>Space Efficient:</b> Because of Fossil's [./delta_format.wiki |
28 delta compression technology], discussions add little to the size
29 of a cloned repository. Ten years of the SQLite project's
30 discussions — averaging about 2 dozen posts per day — compress down
31 to [/forumpost/9b6f3f36bdb | just 35&nbsp;MB of space] in a Fossil
32 forum repository.
33
34 * <b>Built-in Full-Text Search:</b> Fossil forums use
35 [https://sqlite.org/fts3.html | SQLite's powerful FTS4 engine] to
36 handle searches. If your project currently uses a mailing list for
37 discussions, this means you are no longer reliant upon third-party
38 mailing list archive services to provide a useful search engine for
39 your discussions. If you are running a private Fossil repository,
40 you may not even have the <em>option</em> of delegating this useful
41 service to a third-party; Fossil provides this service out of the
42 box.
43
44 * <b>One Result Per Matching Post:</b> When you search the forum
45 archives via the Fossil web interface, you get only one result for
46 each matching post. When you search for project information via a
47 standard web search engine, you might get a result from the project
48 site's own mail archive plus one from Nabble, one from Gmane, one
49 from The Mail Archive...
50
51 * <b>Search Off-Line:</b> Because Fossil is a [./concepts.wiki |
52 distributed version control system], project members can search
53 your forum archive while disconnected from the network where the
54 central Fossil instance runs. Your past discussions are potentially
55 just as valuable as a wiki document or checkin comment: there is no
56 good reason why you should have to wait to get back on the Internet
57 or back to the office before you can search for past posts.
58
59 * <b>Contribute Off-Line:</b> Fossil forum posts work like any other
60 insertion into the repository, so a user can create new threads and
61 reply to existing ones while off-line, then sync their
62 contributions to the server they cloned from when back on-line.
63 Yes, you can post to the forum from inside a tent, miles from the
64 nearest wifi router or cellular data tower.
65
66 * <b>Interlink with Other Fossil-Managed Artifacts:</b> Because forum
67 posts are normal Fossil artifacts, you can interlink them with
68 other Fossil artifacts using short internal links: link to forum
69 threads from a [./tickets.wiki | ticket], link to a wiki document
70 from a forum post, etc.
71
72 * <b>Durable Links:</b> Once you create a valid internal artifact
73 link in Fossil, it <em>remains</em> valid, durably. With
74 third-party forum software and mailing list search engines, your
75 links are only valid until the third-party component changes its
76 URL scheme or disappears from the web.
77
78 * <b>Role-Based Access Control:</b> The forum uses the same
79 [https://en.wikipedia.org/wiki/Role-based_access_control | RBAC
80 system] that Fossil uses to control all other repository accesses.
81 The Fossil forum feature simply adds several new fine-grained
82 capability bits to the existing system.
83
84 * <b>Enduring, Open File Format:</b> Since Fossil has an
85 [./fileformat.wiki | open and well-documented file format], your
86 discussion archives are truly that: <em>archives</em>. You are no
87 longer dependent on the lifetime and business model of a
88 third-party piece of software or service. Should you choose to stop
89 using Fossil, you can easily extract your discussion traffic for
90 transfer to another system.
91
92 * <b>Lightweight Markup:</b> Posts can be marked up using Fossil's
93 existing [/md_rules | Markdown] and [/wiki_rules | Wiki] markup
94 processors. No longer must you choose between two bad options: to
95 restrict posts to plain text only or to allow wild-west
96 HTML-formatted MIME email. Fossil's lightweight markup language
97 formatting features give you a middle path, providing your users
98 enough formatting power to communicate complex ideas well without
99 providing so much power as to risk
100 [https://wonko.com/post/html-escaping | security problems].
101
102 * <b>Easy Notification Emails:</b> Fossil's forum feature integrates
103 with popular [https://en.wikipedia.org/wiki/Message_transfer_agent
104 | message transfer agents] (MTAs) such as Postfix, Exim, and
105 Sendmail. It is easy to configure Fossil to send notifications of
106 new posts to interested forum users via your Fossil server's
107 existing MTA. Notification emails include the complete message
108 content for the benefit of those that prefer to visit the forum
109 only when they need to post something.
110
111 * <b>Talks to Everyone:</b> Because Fossil delegates email handling
112 to your existing MTA, it does not need to implement the
113 [http://sqlite.1065341.n5.nabble.com/Many-ML-emails-going-to-GMail-s-SPAM-tp98685p98722.html
114 | roughly two dozen]
115 [https://en.wikipedia.org/wiki/Request_for_Comments | RFCs] needed
116 to properly support SMTP email in this complex world we've built.
117 As well, this design choice means you do not need to do duplicate
118 configuration, such as to point Fossil at your server's TLS
119 certificate private key in order to support users behind mail
120 servers that require STARTTLS encryption.
121
122
123 <h2>Setting up aFossil Forum</h2>
124
125 <h3>Permissions</h3>
126
127 Fossil forums use the same role-based access control mechanism as
128 for normal Fossil repository logins.
129

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button