Fossil SCM
Several improvements to the new forum.wiki document
Commit
f85bc32619e9a34ffa0ff5abfe5881a452c8c56da0a267092db7831dfa520445
Parent
15b203430781ff3…
1 file changed
+39
-5
+39
-5
| --- www/forum.wiki | ||
| +++ www/forum.wiki | ||
| @@ -13,15 +13,15 @@ | ||
| 13 | 13 | difficult to install, set up, and administer. Fossil Forums aim to |
| 14 | 14 | be as close to zero-configuration as is practical. |
| 15 | 15 | |
| 16 | 16 | * Posts are stored in the Fossil repository using the same |
| 17 | 17 | [./fileformat.wiki | block chain technology] that Fossil uses to |
| 18 | - store your check-ins, wiki documents, etc. Posts sync to clone | |
| 18 | + store your check-ins, wiki documents, etc. Posts sync to cloned | |
| 19 | 19 | repositories in a tamper-proof fashion. |
| 20 | 20 | |
| 21 | 21 | * Because of Fossil's [./delta_format.wiki | delta compression |
| 22 | - technology], discussions add little space to the size of a cloned | |
| 22 | + technology], discussions add little to the size of a cloned | |
| 23 | 23 | repository. Ten years of the SQLite project's discussions — |
| 24 | 24 | averaging 2 or 3 dozen posts per day — compress down to just |
| 25 | 25 | 35 MB of space in a Fossil Forums repository. |
| 26 | 26 | |
| 27 | 27 | * Fossil Forums use [https://sqlite.org/fts3.html | SQLite's powerful |
| @@ -44,13 +44,13 @@ | ||
| 44 | 44 | document from a forum post, etc. These links are internal and |
| 45 | 45 | managed by Fossil itself, so links never become invalid simply |
| 46 | 46 | because your third-party forum software or mailing list search |
| 47 | 47 | engine changed its URL scheme. |
| 48 | 48 | |
| 49 | - * Forum permissions use the same role-based access control mechanism | |
| 50 | - as Fossil itself. | |
| 51 | - | |
| 49 | + * The forum uses the same role-based access control mechanism as | |
| 50 | + Fossil uses for all other accesses. | |
| 51 | + | |
| 52 | 52 | * Since Fossil has an [./fileformat.wiki | open and well-documented |
| 53 | 53 | file format], your discussion archives are truly that: |
| 54 | 54 | <em>archives</em>. You are no longer dependent on a third-party |
| 55 | 55 | piece of software or service sticking around. Should you choose to |
| 56 | 56 | stop using Fossil, you can easily extract your discussion traffic |
| @@ -60,10 +60,22 @@ | ||
| 60 | 60 | Markdown] and [/wiki_rules | Wiki] markup languages. No longer must |
| 61 | 61 | you choose to restrict your discussion forums to plain text only |
| 62 | 62 | (good for security) or to allow HTML-formatted MIME email (good for |
| 63 | 63 | complex discussions). Fossil Forums provide <em>enough</em> |
| 64 | 64 | formatting without giving up security. |
| 65 | + | |
| 66 | + * Fossil forums integrate with third-party [mail transfer | |
| 67 | + agents][MTA]. If you've got mail service configured on the server | |
| 68 | + hosting your Fossil instance, it can send notifications of new | |
| 69 | + posts to interested forum users, complete with message content for | |
| 70 | + those that prefer to visit the forum only when they need to post | |
| 71 | + something. | |
| 72 | + | |
| 73 | + * Because Fossil accepts forum posts only via the web UI, it is | |
| 74 | + inherently [./antibot.wiki | protected against bots]. | |
| 75 | + | |
| 76 | +[MTA]: https://en.wikipedia.org/wiki/Message_transfer_agent | |
| 65 | 77 | |
| 66 | 78 | |
| 67 | 79 | <h2>Setting up a Fossil Forum</h2> |
| 68 | 80 | |
| 69 | 81 | <h3>Permissions</h3> |
| @@ -82,10 +94,32 @@ | ||
| 82 | 94 | either delete or approve posts held for moderation. User also gets |
| 83 | 95 | access to a page (<tt>/modreq</tt>) showing the list of pending |
| 84 | 96 | moderation tasks. |
| 85 | 97 | * <b>Administer</b>: User can grant <b>Write Trusted</b> permission |
| 86 | 98 | to another user, or revoke it. (Currently unimplemented.) |
| 99 | + | |
| 100 | +By default, no Fossil user has permission to use the forums except for | |
| 101 | +users with Setup and Admin capabilities, which get these as part of the | |
| 102 | +large package of other capabilities they get. | |
| 103 | + | |
| 104 | +For public Fossil repositories that wish to accept new users without | |
| 105 | +involving a human, go into Admin → Access and enable the "Allow | |
| 106 | +users to register themselves" setting. You may also wish to give the | |
| 107 | +`anonymous` user category the Read Forum (2) and Write Forum (3) | |
| 108 | +capabilities: this allows people to post without creating an account | |
| 109 | +simply by solving [./antibot.wiki | a simple CAPTCHA]. | |
| 110 | + | |
| 111 | +For a private repository, you will likely wish to give the "23" | |
| 112 | +capability pair to the `reader` user category instead. | |
| 113 | + | |
| 114 | +For either type of repository, you are likely to want to give at least | |
| 115 | +the Write Trusted (4) capability to the `developer` user category. | |
| 116 | + | |
| 117 | +By following this advice, you should not need to tediously add | |
| 118 | +capabilities to individual accounts, except in atypical cases, such as | |
| 119 | +to grant the Moderate Forum capability (5) to an uncommonly | |
| 120 | +highly-trusted user. | |
| 87 | 121 | |
| 88 | 122 | |
| 89 | 123 | <h3>Single Sign-On</h3> |
| 90 | 124 | |
| 91 | 125 | If you choose to host your discussion forums within the same repository |
| 92 | 126 |
| --- www/forum.wiki | |
| +++ www/forum.wiki | |
| @@ -13,15 +13,15 @@ | |
| 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 clone |
| 19 | repositories in a tamper-proof fashion. |
| 20 | |
| 21 | * Because of Fossil's [./delta_format.wiki | delta compression |
| 22 | technology], discussions add little space 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 MB of space in a Fossil Forums repository. |
| 26 | |
| 27 | * Fossil Forums use [https://sqlite.org/fts3.html | SQLite's powerful |
| @@ -44,13 +44,13 @@ | |
| 44 | document from a forum post, etc. These links are internal and |
| 45 | managed by Fossil itself, so links never become invalid simply |
| 46 | because your third-party forum software or mailing list search |
| 47 | engine changed its URL scheme. |
| 48 | |
| 49 | * Forum permissions use the same role-based access control mechanism |
| 50 | as Fossil itself. |
| 51 | |
| 52 | * Since Fossil has an [./fileformat.wiki | open and well-documented |
| 53 | file format], your discussion archives are truly that: |
| 54 | <em>archives</em>. You are no longer dependent on a third-party |
| 55 | piece of software or service sticking around. Should you choose to |
| 56 | stop using Fossil, you can easily extract your discussion traffic |
| @@ -60,10 +60,22 @@ | |
| 60 | Markdown] and [/wiki_rules | Wiki] markup languages. No longer must |
| 61 | you choose to restrict your discussion forums to plain text only |
| 62 | (good for security) or to allow HTML-formatted MIME email (good for |
| 63 | complex discussions). Fossil Forums provide <em>enough</em> |
| 64 | formatting without giving up security. |
| 65 | |
| 66 | |
| 67 | <h2>Setting up a Fossil Forum</h2> |
| 68 | |
| 69 | <h3>Permissions</h3> |
| @@ -82,10 +94,32 @@ | |
| 82 | either delete or approve posts held for moderation. User also gets |
| 83 | access to a page (<tt>/modreq</tt>) showing the list of pending |
| 84 | moderation tasks. |
| 85 | * <b>Administer</b>: User can grant <b>Write Trusted</b> permission |
| 86 | to another user, or revoke it. (Currently unimplemented.) |
| 87 | |
| 88 | |
| 89 | <h3>Single Sign-On</h3> |
| 90 | |
| 91 | If you choose to host your discussion forums within the same repository |
| 92 |
| --- www/forum.wiki | |
| +++ www/forum.wiki | |
| @@ -13,15 +13,15 @@ | |
| 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 MB of space in a Fossil Forums repository. |
| 26 | |
| 27 | * Fossil Forums use [https://sqlite.org/fts3.html | SQLite's powerful |
| @@ -44,13 +44,13 @@ | |
| 44 | document from a forum post, etc. These links are internal and |
| 45 | managed by Fossil itself, so links never become invalid simply |
| 46 | because your third-party forum software or mailing list search |
| 47 | engine changed its URL scheme. |
| 48 | |
| 49 | * The forum uses the same role-based access control mechanism as |
| 50 | Fossil uses for all other accesses. |
| 51 | |
| 52 | * Since Fossil has an [./fileformat.wiki | open and well-documented |
| 53 | file format], your discussion archives are truly that: |
| 54 | <em>archives</em>. You are no longer dependent on a third-party |
| 55 | piece of software or service sticking around. Should you choose to |
| 56 | stop using Fossil, you can easily extract your discussion traffic |
| @@ -60,10 +60,22 @@ | |
| 60 | Markdown] and [/wiki_rules | Wiki] markup languages. No longer must |
| 61 | you choose to restrict your discussion forums to plain text only |
| 62 | (good for security) or to allow HTML-formatted MIME email (good for |
| 63 | complex discussions). Fossil Forums provide <em>enough</em> |
| 64 | formatting without giving up security. |
| 65 | |
| 66 | * Fossil forums integrate with third-party [mail transfer |
| 67 | agents][MTA]. If you've got mail service configured on the server |
| 68 | hosting your Fossil instance, it can send notifications of new |
| 69 | posts to interested forum users, complete with message content for |
| 70 | those that prefer to visit the forum only when they need to post |
| 71 | something. |
| 72 | |
| 73 | * Because Fossil accepts forum posts only via the web UI, it is |
| 74 | inherently [./antibot.wiki | protected against bots]. |
| 75 | |
| 76 | [MTA]: https://en.wikipedia.org/wiki/Message_transfer_agent |
| 77 | |
| 78 | |
| 79 | <h2>Setting up a Fossil Forum</h2> |
| 80 | |
| 81 | <h3>Permissions</h3> |
| @@ -82,10 +94,32 @@ | |
| 94 | either delete or approve posts held for moderation. User also gets |
| 95 | access to a page (<tt>/modreq</tt>) showing the list of pending |
| 96 | moderation tasks. |
| 97 | * <b>Administer</b>: User can grant <b>Write Trusted</b> permission |
| 98 | to another user, or revoke it. (Currently unimplemented.) |
| 99 | |
| 100 | By default, no Fossil user has permission to use the forums except for |
| 101 | users with Setup and Admin capabilities, which get these as part of the |
| 102 | large package of other capabilities they get. |
| 103 | |
| 104 | For public Fossil repositories that wish to accept new users without |
| 105 | involving a human, go into Admin → Access and enable the "Allow |
| 106 | users to register themselves" setting. You may also wish to give the |
| 107 | `anonymous` user category the Read Forum (2) and Write Forum (3) |
| 108 | capabilities: this allows people to post without creating an account |
| 109 | simply by solving [./antibot.wiki | a simple CAPTCHA]. |
| 110 | |
| 111 | For a private repository, you will likely wish to give the "23" |
| 112 | capability pair to the `reader` user category instead. |
| 113 | |
| 114 | For either type of repository, you are likely to want to give at least |
| 115 | the Write Trusted (4) capability to the `developer` user category. |
| 116 | |
| 117 | By following this advice, you should not need to tediously add |
| 118 | capabilities to individual accounts, except in atypical cases, such as |
| 119 | to grant the Moderate Forum capability (5) to an uncommonly |
| 120 | highly-trusted user. |
| 121 | |
| 122 | |
| 123 | <h3>Single Sign-On</h3> |
| 124 | |
| 125 | If you choose to host your discussion forums within the same repository |
| 126 |