Module Installation Guide

Install in under 5 minutes.

Every AdamCoffeeOverflow community module follows the same clean installation path: download the release, extract it, upload the full module folder, then enable it inside FreeScout.

01DownloadGet the latest release ZIP.
02ExtractUnpack the downloaded archive.
03UploadPlace the full folder in /Modules.
04EnableActivate it inside FreeScout.
05ConfigureAdjust settings when available.
Installation

Five straightforward steps.

The module folder always belongs inside FreeScout’s /Modules directory. How you reach that directory depends on your host, container, or server setup.

01
Download

Download the latest module release

Open the module page and use its Latest release button. Download the release ZIP rather than the repository source-code archive.

Browse module releases
02
Extract

Extract the ZIP archive

After extracting the download, you should have one complete module folder.

SmartSearchUI/
├── Controllers/
├── Providers/
├── Resources/
├── Routes/
├── composer.json
└── module.json
Important

Upload the entire module folder—not only the files inside it.

03
Upload

Upload the module to FreeScout

Connect to your server, open your FreeScout installation, and navigate to:

/Modules/

Upload the extracted folder so the final path looks like:

/Modules/SmartSearchUI

Do not upload community modules into /public/modules, and do not modify FreeScout core files.

04
Enable

Enable the module in FreeScout

Sign in as an administrator and open:

ManageModulesEnable

The module should appear automatically after the folder has been uploaded correctly.

05
Configure

Review any module settings

Some modules work immediately after activation. Others add settings under the module page, mailbox settings, or user permissions.

After enabling

Open the module, confirm its settings, and test the affected workflow before using it in production.

Upload Tools

Recommended SFTP clients.

Any secure SFTP client can do the job. These are practical, widely used options.

WinSCP

A mature Windows client with strong synchronization and file-management features.

  • Windows
  • Free and established
  • Advanced controls

FileZilla

A common cross-platform client that supports SFTP and is familiar to many users.

  • Windows
  • macOS
  • Linux

Cyberduck

A clean file-transfer client that works especially well for macOS users.

  • macOS
  • Windows
  • Simple bookmarks

These are suggestions, not requirements or endorsements. Download software only from its official publisher or trusted app-store listing.

First time using SFTP?

Your host provides the connection details.

You normally need four pieces of information:

Show the connection fields
HostYour server address
PortUsually 22
UsernameProvided by your host
Password or keyProvided by your host

Once connected, locate the root of your FreeScout installation and open the /Modules directory.

Before Production

Install safely.

A module installation is simple, but it should still be treated like a software change.

01

Back up first

Keep a recent database backup and a copy of your FreeScout files before installing or updating a module.

02

Check compatibility

Review the module page for its current FreeScout version, licence, release notes, and any specific requirements.

03

Test the workflow

Confirm the affected pages, permissions, mailbox behavior, and mobile layout before broader use.

04

Keep rollback ready

Retain the previous module version so you can restore it if the new release does not behave as expected.

Common Questions

What to expect.

Does the module modify FreeScout core files?

AdamCoffeeOverflow modules are designed to remain contained inside their own module folder and avoid direct core-file modifications.

Can I update without uninstalling first?

Normally, yes. Back up first, review the release notes, replace the module files, and follow any module-specific migration instructions.

Will my existing settings remain?

Settings normally remain during a standard update, but every release should still be reviewed for migration or configuration notes.

Can I remove the module later?

Yes. Disable it inside FreeScout first, then follow the module’s removal or rollback instructions before deleting its folder.

Does my hosting provider matter?

The destination is the same: the FreeScout /Modules directory. The access method may differ depending on whether your host provides SFTP, a file manager, SSH, or container access.

FreeScout References

Confirm the platform guidance.

This guide covers AdamCoffeeOverflow community modules. Use the official FreeScout resources below for platform installation, supported environments, and the distinction between official and community modules.

Important distinction

AdamCoffeeOverflow modules are independent community modules. They are not official FreeScout modules and are not endorsed or supported by the FreeScout team.

Installation Philosophy

Focused modules without core-file hacks.

AdamCoffeeOverflow modules are built to extend FreeScout while keeping the underlying installation maintainable. Each release remains independently versioned, reviewable, and removable.