{"id":13654189,"url":"https://github.com/jfqd/redmine_helpdesk","last_synced_at":"2025-04-23T07:30:42.820Z","repository":{"id":5489543,"uuid":"6687627","full_name":"jfqd/redmine_helpdesk","owner":"jfqd","description":"Lightweight helpdesk plugin for redmine.","archived":false,"fork":false,"pushed_at":"2023-08-22T17:30:04.000Z","size":347,"stargazers_count":193,"open_issues_count":12,"forks_count":102,"subscribers_count":35,"default_branch":"master","last_synced_at":"2024-08-02T02:10:38.504Z","etag":null,"topics":["helpdesk","redmine","redmine-helpdesk"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jfqd.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2012-11-14T12:50:42.000Z","updated_at":"2024-07-25T15:08:09.000Z","dependencies_parsed_at":"2024-01-17T02:14:49.387Z","dependency_job_id":"a41fee8e-d3cf-46bd-b6ae-a0175537dddc","html_url":"https://github.com/jfqd/redmine_helpdesk","commit_stats":{"total_commits":219,"total_committers":28,"mean_commits":7.821428571428571,"dds":0.3561643835616438,"last_synced_commit":"8e3331aecfeb94db0fd74e1297530d0f64347053"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfqd%2Fredmine_helpdesk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfqd%2Fredmine_helpdesk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfqd%2Fredmine_helpdesk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfqd%2Fredmine_helpdesk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jfqd","download_url":"https://codeload.github.com/jfqd/redmine_helpdesk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223913400,"owners_count":17224188,"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":["helpdesk","redmine","redmine-helpdesk"],"created_at":"2024-08-02T02:01:24.588Z","updated_at":"2025-04-23T07:30:42.793Z","avatar_url":"https://github.com/jfqd.png","language":"Ruby","funding_links":[],"categories":["Plugins"],"sub_categories":["Active Plugins"],"readme":"# Redmine Helpdesk\n\nLightweight helpdesk plugin for redmine. Adds the email sender-address of an anonymous supportclient to the custom field 'owner-email' of a ticket which was created by a support email. Answers can be send to the supportclient by checking the support checkbox on a journal.\n\n## Support\n\nYou want to support the development of this plugin? [We provide Redmine hosting including the Helpdesk plugin](https://qutic.com/de/loesungen/redmine-hosting/).\n\n## Features\n\n* No need to create any user accounts for anonymous user\n* Support for sending an email notification to the (anonymous user) supportclient on ticket creation\n* A standard first reply message can be send to the supportclient on ticket creation (optional, per project)\n* The email-footer for the email notification to the supportclient can be adjusted (optional, per project)\n* The email-footer can be customized by using the following placeholders: \n  - Issue parameters\n    - ##issue-id##\n    - ##issue-subject##\n    - ##issue-tracker##\n    - ##issue-status##\n  - Project parameters\n    - ##project-name##\n  - User parameters\n    - ##user-name## \n    - ##user-firstname##\n    - ##user-lastname##\n    - ##user-mail##\n    - ##user-login##\n    - all user custom fields: ##user-cf-[user's custom field name]##, e.g. ##user-cf-position##\n  - Base parameters\n    - ##time-now##\n* The sender email-address can be adjusted (optional, per project)\n* Internal communication is not send to the supportclient\n* The supportclient will get an email notification if the support checkbox on the journal is checked (default value is optional)\n* Journal attachments will be delivered too\n* Cc header is handled if the cc-handling checkbox is checked. (optional, per project)\n* Reopening a closed issue is handled if the reopen-closed-issues-by-email checkbox is checked. (optional, per project)\n\n## Screenshot\n\n![Send mail to supportclient](doc/send-mail-to-supportclient.jpg \"New checkbox 'Send mail to supportclient'\")\n\n## Getting the plugin\n\nA copy of the plugin can be downloaded from [GitHub](https://github.com/jfqd/redmine_helpdesk)\n\n## Installation\n\nTo install the plugin clone the repo from github and migrate the database:\n\n```\ncd /path/to/redmine/\ngit clone git://github.com/jfqd/redmine_helpdesk.git plugins/redmine_helpdesk\nbundle install --without development test rmagick\nbundle exec rake redmine:plugins:migrate RAILS_ENV=production\n```\n\nTo uninstall the plugin migrate the database back and remove the plugin:\n\n```\ncd /path/to/redmine/\nrake redmine:plugins:migrate NAME=redmine_helpdesk VERSION=0 RAILS_ENV=production\nrm -rf plugins/redmine_helpdesk\n```\n\nFurther information about plugin installation can be found at: https://www.redmine.org/wiki/redmine/Plugins\n\n## Usage\n\nTo use the helpdesk functionality you need to\n\n* add the custom field 'owner-email' to a project in the project configuration\n* add a standard first reply message into the custom_field 'helpdesk-first-reply' in the project configuration (optional)\n* add an email-footer into the custom_field 'helpdesk-email-footer' in the project configuration\n* add a sender email address into the custom_field 'helpdesk-sender-email' in the project configuration (optional)\n* make sure 'Issue added' and 'Issue updated' in the general redmine settings for email notifications are checked\n* add the permission 'Treat as supportclient' to all roles you want to be treated as supportclient (the permission is automatically added to the 'Anonymous' role)\n* disable standard notifications for non-anonymous supportclients to prevent their spamming (optional)\n* add a cronjob for creating issues from support emails\n\n![project configuration sample](doc/project-settings.jpg \"Per project configuration sample\")\n\n## Cronjob\n\nCreating tickets from support emails through an IMAP-account is done by a cronjob. If you are not familiar with cron you first should read about the concept. The following syntax is for ubuntu or debian linux:\n\n```\n*/5 * * * * redmineuser /path/to/your/rake -f /path/to/redmine/Rakefile --silent redmine:email:receive_imap RAILS_ENV=\"production\" host=mail.example.com port=993 username=username password=password ssl=true project=project_identifier folder=INBOX move_on_success=processed move_on_failure=failed no_permission_check=1 unknown_user=accept 1 \u003e /dev/null\n```\n\nFurther information about receiving emails with redmine can be found at: [https://www.redmine.org/projects/redmine/wiki/RedmineReceivingEmails](https://www.redmine.org/projects/redmine/wiki/RedmineReceivingEmails#Fetching-emails-from-an-IMAP-server)\n\nPlease note that forwarding emails with **rdm-mailhandler.rb** is currently **not supported** by the plugin.\n\n## Compatibility\n\nThe latest version of this plugin is only compatible with Redmine 5.0, 5.1 and 6.0.\n\n* A version for Redmine 4.2.x is tagged with [v4.2](https://github.com/jfqd/redmine_helpdesk/releases/tag/v4.2 \"plugin version for Redmine 4.2.x\") and available for [download on github](https://github.com/jfqd/redmine_helpdesk/archive/v4.2.zip \"download plugin for Redmine 4.2.x\").\n* A version for Redmine 4.0.x is tagged with [v4.0](https://github.com/jfqd/redmine_helpdesk/releases/tag/v4.0 \"plugin version for Redmine 4.0.x\") and available for [download on github](https://github.com/jfqd/redmine_helpdesk/archive/v4.0.zip \"download plugin for Redmine 4.0.x\").\n* A version for Redmine 3.0.x and 3.1.x is tagged with [v3.1](https://github.com/jfqd/redmine_helpdesk/releases/tag/v3.1 \"plugin version for Redmine 3.0.x and 3.1.x\") and available for [download on github](https://github.com/jfqd/redmine_helpdesk/archive/v3.1.zip \"download plugin for Redmine 3.0.x and 3.1.x\").\n* A version for Redmine 2.4.x and 2.5.x is tagged with [v2.5](https://github.com/jfqd/redmine_helpdesk/releases/tag/v2.5 \"plugin version for Redmine 2.4.x and 2.5.x\") and available for [download on github](https://github.com/jfqd/redmine_helpdesk/archive/v2.5.zip \"download plugin for Redmine 2.4.x and 2.5.x\").\n* A version for Redmine 2.3.x is tagged with [v2.3](https://github.com/jfqd/redmine_helpdesk/tree/v2.3 \"plugin version for Redmine 2.3.x\") and available for [download on github](https://github.com/jfqd/redmine_helpdesk/archive/v2.3.zip \"download plugin for Redmine 2.3.x\").\n* A version for Redmine 1.2.x. up to 1.4.7. is tagged with [v1.4](https://github.com/jfqd/redmine_helpdesk/tree/v1.4 \"plugin version for Redmine 1.2.x up to 1.4.7\") and available for [download on github](https://github.com/jfqd/redmine_helpdesk/archive/v1.4.zip \"download plugin for Redmine 1.2.x up to 1.4.7\").\n\nIf you prefer to run Redmine with JRuby make sure to use Redmine versions prior to 3.0.x!\n\n## Development\n\n### Testing\n\nRake tasks for testing against Redmine are provided. Redmine is installed under `test/app` and tests are run against the local instance.\n\n```bash\nREDMINE_VERSION=3.2 DATABASE_ADAPTER=mysql rake helpdesk:redmine:install\n```\n\nDocker is used to provide local MySQL (`DATABASE_ADAPTER=mysql`) and PostgreSQL (`DATABASE_ADAPTER=postgresql_ext`) instances.\n\n```bash\nexport DATABASE_ADAPTER=mysql\nrake helpdesk:prepare_local\nrake helpdesk:migrate\n```\n\nTest suite can be executed with:\n\n```bash\nDATABASE_ADAPTER=mysql rake helpdesk:ext_ci\n```\n\nThe local database instance has to be stopped with a rake task:\n\n```bash\nrake helpdesk:localdb:stop\n```\n\n## Contributions\n\n* [MatthiasPetermann](https://github.com/MatthiasPetermann) - Update for compatibility with Redmine 5.x / Rails 6.x\n* [rrsach](https://github.com/rrsach) - Redmine 5 Compatibility\n* [gianpaol0](https://github.com/gianpaol0) - italian translation\n* [mgeerdsen](https://github.com/mgeerdsen) - Fix reopening closed issue error\n* [mgeerdsen](https://github.com/mgeerdsen) - Improve de locale\n* [lmorillas](https://github.com/lmorillas) - Fix Error when message hasn't \"To:\" header\n* [promasu](https://github.com/promasu) - Add X-Redmine-Issue-Tracker header to mailerpatch\n* [ANemcov](https://github.com/ANemcov) - incorrect issue and project ids usage\n* [ismaelgc](https://github.com/ismaelgc) - Spanish translation\n* [monaka](https://github.com/monaka) - Japanese translation\n* [avoidik](https://github.com/avoidik) - Add missed Russian translation into roles and access manager\n* [WhereIsPedro](https://github.com/WhereIsPedro) - Polish translation\n* [vilppuvuorinen](https://github.com/vilppuvuorinen) - 3.0.x compatibility\n* [vilppuvuorinen](https://github.com/vilppuvuorinen) - Unit and functional tests with travis and code climate support\n* [ssidelnikov](https://github.com/ssidelnikov) - Make sure that the notes length is always calculated\n* [nifuki](https://github.com/nifuki) - Fixed bug trying to send an email with empty notes\n* [nifuki](https://github.com/nifuki) - Fixed non-working helpdesk-send-to-owner-default checkbox\n* [box789](https://github.com/box789) - Russian translation\n* [seqizz](https://github.com/seqizz) - Turkish translation\n* [benstwa](https://github.com/benstwa) - 'send' should be 'sent'\n* [davidef](https://github.com/davidef) - Add setting for handling sent to owner default value\n* [Craig Gowing](https://github.com/craiggowing) - Redmine 2.4 compatibility\n* [Barbazul](https://github.com/barbazul) - Added reply-to header\n* [Orchitech Solutions](https://github.com/orchitech) - Added issue matching based on standard MIME header references\n* [Orchitech Solutions](https://github.com/orchitech) - Added support for non-anonymous supportclients (sponsored by ISIC Global Office)\n* [Orchitech Solutions](https://github.com/orchitech) - Added support for customizable email footers (sponsored by ISIC Global Office)\n* [Orchitech Solutions](https://github.com/orchitech) - Added support for tracking email details (sponsored by ISIC Global Office)\n* [shackijj](https://github.com/shackijj) - Added Cc header handling\n* [archonwang](https://github.com/archonwang) - Add Simplified Chinese\n* [Niremizov](https://github.com/Niremizov) - Set owner email only if it wasn't set before\n* [ghost](https://github.com/ghost) - Fix attachements truncated in email sent to supportclient\n* [Orchitech Solutions](https://github.com/orchitech) - Added support for reply separator (sponsored by ISIC Global Office)\n\n## License\n\nThis plugin is licensed under the MIT license. See LICENSE-file for details.\n\n## Copyright\n\nCopyright (c) 2012-2022 qutic development GmbH\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjfqd%2Fredmine_helpdesk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjfqd%2Fredmine_helpdesk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjfqd%2Fredmine_helpdesk/lists"}