GoAdmio

snappymail

Install or reinstall SnappyMail webmail (version 2.38.2) under GoAdmio's webmail folder, keeping the existing data folder, and show where to find the admin area

On this page: Overview · Quick start · Syntax · Options · Output · Examples · Troubleshooting · Details · See also


Overview

SnappyMail is a lightweight webmail client. Users log in with their normal mailbox address and password, and read and send mail through the server's IMAP and SMTP services. /go/snappymail installs it, or reinstalls it over an existing copy. It:

The mail itself is not stored in SnappyMail. It stays on the server's mail system, so reinstalling doesn't touch anyone's messages.

[!WARNING] The command makes the data folder readable and writable by everyone (chmod 777). That folder includes the admin password file. The old copy is deleted before the new one is downloaded, so a failed download leaves the webmail broken until you run the command again. See Security.


Quick start

/go/snappymail

Then open https://webmail.<your domain>/snappymail/?admin to reach the admin area. The user name is admin, and the password is in:

cat /usr/local/goadmio/home/go/webmail/snappymail/data/_data_/_default_/admin_password.txt

Syntax

/go/snappymail
Form Behavior
/go/snappymail Installs SnappyMail, or reinstalls it and keeps its data.

The command takes no arguments. Anything you add is only written to the log. Run it as root.


Options

None.

The version is fixed in the script at 2.38.2. Running the command again reinstalls that same version. You get a newer version only when the script itself is updated, for example by update.


Output

The command prints only the progress message Installing SnappyMail Webmail, shown through GoAdmio's progress display.

Notes on the output:


Examples

# Install, or reinstall and keep the data
/go/snappymail
# Check that the files are in place
ls /usr/local/goadmio/home/go/webmail/snappymail
# Read the admin password
cat /usr/local/goadmio/home/go/webmail/snappymail/data/_data_/_default_/admin_password.txt
# Copy your saved data back by hand, if the restore step didn't work
/go/cf /var/go/snappymail/data /usr/local/goadmio/home/go/webmail/snappymail/data

Troubleshooting

Symptom Likely cause Fix
The webmail shows an error or a blank page after the command The download failed after the old copy was deleted, for example no access to github.com, or the release file was removed. Check the server's internet access and DNS (see resolver), then run the command again.
Settings are back to defaults after a reinstall No data folder was found to back up, or the restore didn't work. Look in /var/go/snappymail/data. If your settings are there, copy them back with the cf command shown above.
An old backup was restored over a new install /var/go/snappymail/data is kept between runs and is restored whenever it exists. Delete /var/go/snappymail/data before a clean install.
You can't find the admin password The file doesn't exist yet. Open the admin URL once, then check the file again.
Users can't log in The domain or its mail server settings aren't set up in the SnappyMail admin area, or the mail service has a problem. Check the domains in the admin area, then use troubleshoot.
Files were unpacked in the wrong folder The cd into the webmail folder failed (for example, the command wasn't run as root), and the download continued in the current folder. Delete the stray snappymail-2.38.2.tar.gz and unpacked files, and run the command as root.
You want a newer SnappyMail version The version is fixed in the script. Run update to get the latest GoAdmio scripts.
Disk space is used in /var/go/snappymail/data The backup copy is kept after the install. Delete it when you no longer need it.

Details

What happens on each run

flowchart TD
    A["snappymail"] --> B["Log the call, show the progress message"]
    B --> C{"Old data folder exists?"}
    C -- "Yes" --> D["Copy it to /var/go/snappymail/data"]
    C -- "No" --> E
    D --> E["Delete the old snappymail folder"]
    E --> F["Download snappymail-2.38.2.tar.gz from GitHub, unpack it, delete the archive"]
    F --> G{"/var/go/snappymail/data exists?"}
    G -- "Yes" --> H["Copy it into the new data folder"]
    G -- "No" --> I
    H --> I["chmod 777 -R on the data folder"]

Folders and files

Path Purpose
/usr/local/goadmio/home/go/webmail/snappymail The SnappyMail installation. It is deleted and recreated on every run.
.../snappymail/data SnappyMail's settings and data. It is kept across reinstalls.
.../data/_data_/_default_/admin_password.txt The admin password.
/var/go/snappymail/data The backup copy of data, made by cf. It is not deleted afterwards.

Downtime

Between the deletion of the old folder and the end of the unpacking, the webmail is unavailable. This is normally a few seconds, longer on a slow connection.

Security

Risk Detail
World-writable data folder chmod 777 -R lets any local user who can reach the path read and change the settings, the admin password file, and the saved data.
Admin area reachable /snappymail/?admin is open to the internet. Change the admin password after your first login.
Download not verified The archive is fetched over HTTPS from GitHub, and its checksum or signature isn't checked.
Backup copy /var/go/snappymail/data holds the same data as the live folder and stays on disk.

See also

Command Description
roundcube Install Roundcube webmail on GoAdmio
installmail Install and configure webmail services (Postfix and Dovecot)
troubleshoot Troubleshoot email problems in GoAdmio
checkimap Check the IMAP hostname, its DNS record, and the SSL certificate on port 993
cf Copy the contents of a folder to another folder on this server, or to a remote server, with rsync
update Update GoAdmio to the latest version via the command line