Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
| Comment: | Assorted minor improvements to the www/alerts.md document. The major one is re-emphasizing the need to give capability 7 to some user or user category. Ask me how I came to think this necessary. :) |
|---|---|
| Downloads: | Tarball | ZIP archive | SQL archive |
| Timelines: | family | ancestors | descendants | both | trunk |
| Files: | files | file ages | folders |
| SHA3-256: |
3e75a683efb801f73c3d14cbd3cdac7b |
| User & Date: | wyoung 2018-08-13 03:23:59 |
Context
|
2018-08-13
| ||
| 03:51 | Covered capability 7 in the forum.wiki document, and made several improvements to the "Using the Moderation Feature" section. (check-in: 31631b75 user: wyoung tags: trunk) | |
| 03:23 | Assorted minor improvements to the www/alerts.md document. The major one is re-emphasizing the need to give capability 7 to some user or user category. Ask me how I came to think this necessary. :) (check-in: 3e75a683 user: wyoung tags: trunk) | |
| 01:11 | Typo fix (check-in: c3d9c8e0 user: wyoung tags: trunk) | |
Changes
Changes to www/alerts.md.
1 2 3 4 5 6 7 8 9 10 11 12 .. 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 .. 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 .. 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 ... 143 144 145 146 147 148 149 150 151 152 |
Email Alerts ============ The email alert system is a work-in-progress. This documentation was last updated on 2018-08-08. Check back later for updates. Email Alerts And Notifications ------------------------------ Beginning with version 2.7, Fossil supports the ability to send email messages to subscribers alerting them to changes in the repository. ................................................................................ * New check-ins * Changes to any ticket * Changes to any wiki page * New forum posts * Announcements Subscribers can elect to receive emails as soon as these events happen, or to receive a daily digest of the events. Email alerts are sent by a [Fossil server](./server.wiki). You must have a server setup to make use of email alerts. Email alerts do not (currently) work if you are only using Fossil from the command-line. Users and Subscribers --------------------- Fossil makes a distinction between "users" and "subscribers". A "user" is someone with a username and password - someone who can log in. A "subscriber" is someone who receives email alerts. Users can also be subscribers and subscribers can be users, but that does not have to be the case. It is possible to be a user without being a subscriber and to be a subscriber without being a user. In the repository database file, users are tracked with the USER table and subscribers are tracked via the SUBSCRIBER table. Activating Email Alerts ----------------------- Email alerts are turned off by default. To activate them, log into the Fossil server as an administrator and visit the [Admin/Notification](/setup_notification) setup page ([/setup_notification](/setup_notification)). Important: Email alerts are configured using Admin/Notification, not Admin/Email-Server. The Email-Server setup screen is used to configure a different subsystem within Fossil. The Admin/Notification setup screen lets you configure how Fossil should send email for alerts. There are some required fields at the top of the ................................................................................ screen for elements such as the "From:" address for outgoing emails, the URL for the Fossil server, and a nickname for the repository that will appear in the "Subject:" line of outgoing emails. But the key setup parameter is the "Email Send Method". Fossil supports multiple methods for sending email alerts: 1. Pipe the email message text into a command, such as "sendmail". 2. Store email messages as individual files in a directory and let some other process set up by the administrator take care of reading and forwarding those files. 3. Store email messages as entries in an SQLite database where some external process and read and forward the emails. 4. Send emails to an SMTP Relay. 5. Send emails directly to the recipients via SMTP. ................................................................................ "procmail" to be sent on to the final recipient. The self-hosting Fossil repository uses this technique rather than method (1) because it is running inside of a restrictive chroot jail which is unable to hand off messages to "procmail" directly. The daemon that monitors the email database is a [short TCL script](/file/tools/email-sender.tcl). That daemon is started automatically by adding this line: > /usr/bin/tclsh /home/www/fossil/email-sender.tcl & To the "/etc/rc.local" file of the Ubuntu server that hosts the repository. After making necessary changes to the Admin/Notification page, test those changes by clicking the "[Send Announcement](/announce)" link at the top of the page. Fill in your email address in the "To:" line and a test message below, and press "Send Message" to verify that outgoing email is working. Once email notification is working, one must also adjust user permissions to allow users to subscribe to email notification. On the Setup/User page, under the permissions for each user, is a new capability called "Email Alerts". The corresponding capability letter is "7". That new "7" capability must be enabled in order for users to be able to become subscribers. To allow anonymous passers-by on the internet to subscribe, simply enable "Email Alerts" for the special "nobody" user. Signing Up For Email Notification --------------------------------- Users and/or anonymous passers-by can visit the [/subscribe](/subscribe) page to sign up for email notification. After signing up, a single verification email is sent. The new subscriber must click a link on that email in order to activate the subscription. Subscription verification emails are only sent once. This is a defense against malicious robots that try to harass innocent internet users by having subscription pages send multiple verification emails. If the initial subscription verification does not go through correctly, an administrator must intervene to reset the subscription. Every subscriber has a long random hexadecimal security code that serves as their password. All email notifications contain a link back to the Fossil server, incorporating this security code, that allows the subscriber to adjust their subscription options. Administrator Activities ------------------------ The repository administrator has unlimited control over individual subscriptions. The "[List Subscribers](/subscribers)" button at the top ................................................................................ The Setup/Notification settings are not replicated using clone or sync. In a network of peer repositories, you only want one repository sending email notifications. If you were to replicate the email notification settings to a separate repository, then subscribers would get multiple notifications for each event, which would be bad. However, the subscriber list can be synced for backup purposes. Use the "[fossil config pull subscriber](/help?cmd=configuration)" command to pull the latest subscriber list from a server into a backup repository. |
| | | | | > | | > | | | | > | > | > > > > > > > > > > > > | | | | | |
1 2 3 4 5 6 7 8 9 10 11 12 .. 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 .. 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 .. 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 ... 159 160 161 162 163 164 165 166 167 168 |
Email Alerts ============ The email alert system is a work-in-progress. This documentation was last updated on 2018-08-12. Check back later for updates. Email Alerts And Notifications ------------------------------ Beginning with version 2.7, Fossil supports the ability to send email messages to subscribers alerting them to changes in the repository. ................................................................................ * New check-ins * Changes to any ticket * Changes to any wiki page * New forum posts * Announcements Subscribers can either elect to receive emails as soon as these events happen, or they can receive a daily digest of the events instead. Email alerts are sent by a [Fossil server](./server.wiki). You must have a server [set up to make use of email alerts](#setup). Email alerts do not currently work if you are only using Fossil from the command line. Users and Subscribers --------------------- Fossil makes a distinction between "users" and "subscribers". A user is someone with a username and password — someone who can log in. A subscriber is someone who receives email alerts. Users can also be subscribers and subscribers can be users, but that does not have to be the case. It is possible to be a user without being a subscriber and to be a subscriber without being a user. In the repository database file, users are tracked with the USER table and subscribers are tracked via the SUBSCRIBER table. <a id="setup"></a> Activating Email Alerts ----------------------- Email alerts are turned off by default. To activate them, log into the Fossil server as an administrator and visit the [Admin/Notification](/setup_notification) setup page. ([`/setup_notification`](/setup_notification)) Important: Email alerts are configured using Admin/Notification, not Admin/Email-Server. The Email-Server setup screen is used to configure a different subsystem within Fossil. The Admin/Notification setup screen lets you configure how Fossil should send email for alerts. There are some required fields at the top of the ................................................................................ screen for elements such as the "From:" address for outgoing emails, the URL for the Fossil server, and a nickname for the repository that will appear in the "Subject:" line of outgoing emails. But the key setup parameter is the "Email Send Method". Fossil supports multiple methods for sending email alerts: 1. Pipe the email message text into a command, such as `sendmail`. 2. Store email messages as individual files in a directory and let some other process set up by the administrator take care of reading and forwarding those files. 3. Store email messages as entries in an SQLite database where some external process and read and forward the emails. 4. Send emails to an SMTP Relay. 5. Send emails directly to the recipients via SMTP. ................................................................................ "procmail" to be sent on to the final recipient. The self-hosting Fossil repository uses this technique rather than method (1) because it is running inside of a restrictive chroot jail which is unable to hand off messages to "procmail" directly. The daemon that monitors the email database is a [short TCL script](/file/tools/email-sender.tcl). That daemon is started automatically by adding this line: /usr/bin/tclsh /home/www/fossil/email-sender.tcl & To the `/etc/rc.local` file of the Ubuntu server that hosts the repository. After making necessary changes to the Admin/Notification page, test those changes by clicking the "[Send Announcement](/announce)" link at the top of the page. Fill in your email address in the "To:" line and a test message below, and press "Send Message" to verify that outgoing email is working. <a id="cap7"></a> Once email notification is working, one must also adjust user permissions to allow users to subscribe to email notification. On the Setup/User page, under the permissions for each user, is a new capability called "Email Alerts". The corresponding capability letter is "7". That new "7" capability must be enabled in order for users to be able to become subscribers. To allow anonymous passers-by on the internet to subscribe, simply enable "Email Alerts" for the "nobody" user category. To require that the user solve a simple CAPTCHA first, add it to the "anonymous" user category instead. Signing Up For Email Notification --------------------------------- Users and/or anonymous passers-by can visit the [`/subscribe`](/subscribe) page to sign up for email notification. If your users are getting the following complaint from Fossil: <blockquote> Use a different login with greater privilege than FOO to access /subscribe </blockquote> ...then you forgot to [give capability 7](#cap7) to that user or to a user category that the user is a member of. After signing up, a single verification email is sent. The new subscriber must click a link on that email in order to activate the subscription. Subscription verification emails are only sent once. This is a defense against malicious robots that try to harass innocent internet users by having subscription pages send multiple verification emails. If the initial subscription verification does not go through correctly, an administrator must intervene to reset the subscription. Every subscriber has a long random hexadecimal security code that serves as their password. All email notifications contain a link back to the Fossil server, incorporating this security code, which allows the subscriber to adjust their subscription options. Administrator Activities ------------------------ The repository administrator has unlimited control over individual subscriptions. The "[List Subscribers](/subscribers)" button at the top ................................................................................ The Setup/Notification settings are not replicated using clone or sync. In a network of peer repositories, you only want one repository sending email notifications. If you were to replicate the email notification settings to a separate repository, then subscribers would get multiple notifications for each event, which would be bad. However, the subscriber list can be synced for backup purposes. Use the [`fossil config pull subscriber`](/help?cmd=configuration) command to pull the latest subscriber list from a server into a backup repository. |