Max Mehl becdfdafaf
All checks were successful
continuous-integration/drone/push Build is passing
add tobiasd's GPG key to the vaultpw.gpg file
2024-09-02 11:10:12 +02:00
2023-05-08 17:45:43 +02:00
2023-05-08 17:46:55 +02:00
2023-05-31 10:17:18 +02:00
2023-05-08 17:44:38 +02:00
2023-05-08 17:46:39 +02:00
2023-06-19 18:23:17 +02:00

in
docs.fsfe.org Build
Status

FSFE Helpdesk

This repo documents the deployment of the FSFE Helpdesk running on FreeScout. It aims to replace the FSFE's old Ticketing system based on OTRS.

Why FreeScout is Superior to OTRS

  1. Modern and User-friendly Interface: FreeScout offers a clean and modern user interface, making it easier to navigate and manage tickets, while OTRS has an outdated and cumbersome interface.
  2. Simpler Configuration, lightweight deployment: FreeScout's setup and customization are simpler and more intuitive, resulting in less time spent on technical configuration. Also, FreeScout is prerry lightweight, i.e. there aren't many moving part, meaning it's easy to deploy and backup.
  3. Committed to free software: FreeScout is licensed under AGPL, while OTRS switched to a proprietary license.
  4. Flexible Modules: FreeScout offers an extensive and continually growing list of modules, allowing organizations to add only the features they need.
  5. Active Development and Support: FreeScout is actively developed and has a responsive support community, ensuring that issues are resolved quickly and the software stays up-to-date.

Installation

To start the installation, one needs to run:

ansible-playbook playbook.yml

To see the variable freescout_db_password, when prompted to use the web installer, run:

ansible -m debug -a "var=freescout_db_password" urbain.fsfeurope.org

Finally, you need to add a cron job for the user www-data

crontab -u www-data -e

Then, insert the following using your favourite text editor:

* * * * * /usr/bin/php7.4 /var/www/html/artisan schedule:run >> /dev/null 2>&1

Configuration

The following IMAP accounts are reserved for use with this system:

Name Email Aliases LDAP uid for IMAP Description
General (Admin) admin@fsfe.org (not actually used for correspondence) contact@fsfe.org helpdesk The general mailbox from which admin assign tickets to certain user groups (i.e. staff or team)
General (Staff) staff@fsfe.org (not actually used for correspondence) contact@fsfe.org devnull The general mailbox for everybody in staff to work on conversations
General (Team) team@fsfe.org (not actually used for correspondence) contact@fsfe.org devnull The general mailbox for everybody in team to work on conversations
GDPR Requests privacy@fsfe.org privacy The mailbox used for GDPR requests
Job Applications jobs@fsfe.org jobs The mailbox used for job applications
License Questions license_questions@fsfe.org license-questions@fsfe.org license_questions The mailbox used for responding to license questions
System Administration syshackers@fsfe.org syshackers The mailbox used for system administration
Merchandise merch@fsfe.org merch The mailbox used for all things related to promo material and merchandise orders

Mailboxes are generally configured using the following parameters:

Key Value
Protocol IMAP
Server imap.fsfe.org
Port 993
Username <LDAP uid>@imap.fsfe.org
Password LDAP Password
Encryption TLS
Validate Certificate On

The passwords for the LDAP accounts are all stored in this repo.

Integrations into other systems run by FSFE

TODO Link to all the parts mentioned here

Modules

All available FreeScout modules can be found here.

The wishlist of modules for the FSFE's instance of FreeScout is as follows (this list will be updated as the modules are installed):

Module Price in € Installed?
Tags 7,99 Yes
Saved Replies 5,99 Yes
Workflows 16,99 Yes
Customization 12,99 Yes
Custom Fields 8,99 Yes
Custom Folders 7,99 No
CRM 12,99 No
API Webhooks 14,99 Yes
Extended Editor 2,99 Yes
Extended Attachements 7,00 No
Mentions 6,00 No
Spam Filter 6,99 Yes
2FA 6,99 No
Send Later 5,00 No
Followers 7,99 No
LDAP 20,99 Yes
Teams 13,00 Yes
Email Commands 7,99 No
Checklists 8,00 No
Send & Close 4,00 No
Keyboard Shortcuts 5,99 Yes
Snooze 6,00 No
GDPR 6,00 Yes
Export Conversations 7,00 No
Move or Remove IMAP Message 5,00 Yes
User Fields 9,00 No
Mailbox Icons 5,00 No
Mail Signing & Encryption 27,00 No
Sticky Notes 4,00 No
Description
This repository deploys the FSFE's ticket system.
Readme 66 KiB
Languages
Jinja 87.4%
Shell 12.6%