{"id":26711521,"url":"https://github.com/trac-hacks/trac-wikinotification","last_synced_at":"2025-04-13T19:50:58.492Z","repository":{"id":7708310,"uuid":"9073173","full_name":"trac-hacks/trac-wikinotification","owner":"trac-hacks","description":"Trac's WikiNotificationPlugin with some improvements.","archived":false,"fork":false,"pushed_at":"2020-04-24T22:20:08.000Z","size":152,"stargazers_count":3,"open_issues_count":2,"forks_count":5,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-27T10:34:51.208Z","etag":null,"topics":["trac-plugin"],"latest_commit_sha":null,"homepage":"https://trac-hacks.org/wiki/WikiNotificationPlugin","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/trac-hacks.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-03-28T08:42:11.000Z","updated_at":"2020-04-24T22:20:11.000Z","dependencies_parsed_at":"2022-09-09T15:21:47.099Z","dependency_job_id":null,"html_url":"https://github.com/trac-hacks/trac-wikinotification","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trac-hacks%2Ftrac-wikinotification","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trac-hacks%2Ftrac-wikinotification/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trac-hacks%2Ftrac-wikinotification/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trac-hacks%2Ftrac-wikinotification/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/trac-hacks","download_url":"https://codeload.github.com/trac-hacks/trac-wikinotification/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248773706,"owners_count":21159516,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["trac-plugin"],"created_at":"2025-03-27T10:28:48.085Z","updated_at":"2025-04-13T19:50:58.464Z","avatar_url":"https://github.com/trac-hacks.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"==============================\n Trac Wiki Notification Plugin\n==============================\n\nTrac WikiNotification is a plugin that allows users(even anonymous,\nas long as email is set) to select the wiki pages that they wish to\nbe notified(by email) when a change occurs on it.\n\n**Note**: The user updating the wiki page won't be notified about his own\nchanges.\n\nEnabling the Plugin\n-------------------\nIt's as simple as:\n\n.. sourcecode:: ini\n\n   [components]\n   wikinotification.* = enabled\n\n``smtp_enabled`` has to be enabled in ``notification`` configuration section.\n\nAvailable Configuration Options\n-------------------------------\nThese are the options available to include on your ``trac.ini`` under\n``wiki-notification``. You can configure them through the web admin interface, too.\n\n=====================  ==========================  ==========================\n **Config Setting**     **Default Value**          **Explanation**\n---------------------  --------------------------  --------------------------\n*redirect_time*        5 (in seconds)              The default seconds a\n                                                   redirect should take when\n                                                   watching/un-watching a\n                                                   wiki page.\n                                                   This value is also\n                                                   definable per user, ie,\n                                                   user is able to configure\n                                                   this, of course for\n                                                   himself.\n---------------------  --------------------------  --------------------------\n*smtp_always_bcc*      *empty*                     Comma separated list of\n                                                   email address(es) to\n                                                   always send notifications\n                                                   to, addresses do not\n                                                   appear publicly (Bcc:).\n---------------------  --------------------------  --------------------------\n*smtp_always_cc*       *empty*                     Comma separated list of\n                                                   email address(es) to\n                                                   always send notifications\n                                                   to, addresses can be seen\n                                                   by all recipients (Cc:).\n---------------------  --------------------------  --------------------------\n*from_email*           trac.wiki\\@localhost        Sender address to use in\n                                                   notification emails.\n---------------------  --------------------------  --------------------------\n*from_name*            None                        Sender name to use in\n                                                   notification emails.\n                                                   Defaults to project name.\n---------------------  --------------------------  --------------------------\n*use_public_cc*        False                       Recipients can see email\n                                                   addresses of other CC'ed\n                                                   recipients. If this option\n                                                   is disabled(the default),\n                                                   recipients are put on BCC.\n---------------------  --------------------------  --------------------------\n*attach_diff*          False                       Send changes diff as an\n                                                   attachment instead of on\n                                                   the email text body.\n---------------------  --------------------------  --------------------------\n*subject_template*     $prefix $pagename $action   A Genshi text template\n                                                   snippet used to get the\n                                                   notification subject.\n---------------------  --------------------------  --------------------------\n*banned_addresses*     *empty*                     Comma separated list of\n                                                   email addresses to never\n                                                   send notifications to.\n=====================  ==========================  ==========================\n\nIf you want to override these settings then you can include it like the\nfollowing example:\n\n.. sourcecode:: ini\n\n   [wiki-notification]\n   redirect_time = 5\n   smtp_always_bcc = someone@somedomain, another.one@somedomain\n   smtp_always_cc = someone.else@somedomain\n   from_email = trac.wiki@localhost\n   from_name = Custom Name\n   use_public_cc = false\n   attach_diff = true\n   subject_template = Foo $prefix $pagename $action\n   banned_addresses = banned.user1@somedomain, banned.user2@somedomain\n\nDownload and Installation\n-------------------------\n\nRun the following to install this plugin:\n\n.. sourcecode:: sh\n\n   \u003e sudo pip install TracWikiNotification\n\nAditional Notes(from user input)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* ``pip`` is run from the command line (on Linux) not from within\n  Python.\n\n\n* After installing any plugin for Trac you'll need to restart Apache to see\n  it (not all changes to trac.ini require a restart but adding a plugin does).\n\n\n* Make sure to add the new plugin to ``trac.ini`` :\n\n  .. sourcecode:: ini\n\n    [components]\n    wikinotification.* = enabled\n\n\n* Also should be noted that the ``trac.ini`` configuration for the wiki\n  notification should look something like:\n\n  .. sourcecode:: ini\n\n    [wiki-notification]\n    smtp_always_cc = someone@somedomain\n    from_email = trac.wiki@localhost\n\n\n* **Another note**: a user will never get a notice of his/her own wiki\n  modification (which is a little tricky when testing the plugin :))\n\n* Please note that older versions of the plugin may set a subject_template config value, similar to\n  `subject_template = $prefix $page.name $action`.  This will result in '`UndefinedError: \"page\" not defined`'.\n  Use `$pagename` instead of `$page.name`.\n\nTweaking/Customizing The Notification Email Template\n----------------------------------------------------\nYou can, if you wish, tweak the notification email template sent to your users.\n\nCopy the ``wiki_notification_email_template.txt`` file to your trac environment\n``templates/`` sub-directory and tweak it to your needs.\n\nMake sure you read the `Genshi Text Templates`_ documentation to see if you don't\nbreak any of the logic in that template.\n\n\n.. _Easy Install: http://peak.telecommunity.com/DevCenter/EasyInstall\n.. _Genshi Text Templates: http://genshi.edgewall.org/wiki/Documentation/0.4.x/text-templates.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrac-hacks%2Ftrac-wikinotification","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrac-hacks%2Ftrac-wikinotification","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrac-hacks%2Ftrac-wikinotification/lists"}