Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
739 lines (520 sloc) 21.8 KB

Frequently asked questions

Authors: Michael JasonSmith
Contact: Michael JasonSmith <>
Date: 2016-04-05
Copyright: This document is licensed under a Creative Commons Attribution-Share Alike 4.0 International License by

If you have a question that is missing from the list below feel free to ask in the GroupServer Development group.

How do I...

.. index::
   double: Administration; Site

... add another site administrator?

Multiple people can administer a site. A person must already have a profile to be an administrator. (The easiest way to create one is to create a support group and add the new site administrator to that.)

  1. Log into the :ref:`ZMI <ZMI Login>`.
  2. Visit the folder for your site in :file:`/groupserver/Content`.
  3. Select the :guilabel:`Security` tab.
  4. Click :guilabel:`local roles` at the top of the page.
  5. Enter the user-identifier (it is the last segment of the profile URL, between the / characters) into the :guilabel:`User` entry.
  6. Select :guilabel:`DivisionAdmin` from the :guilabel:`Roles` list.
  7. Click the :guilabel:`Add` button.


The site administrator can change any group, but only :index:`group administrators <pair: Administration; Group>` will receive notifications about each group. A site administrator can be made a group administrator using the Manage members page.

[From Support]

.. index::
   single: Host name
   single: Domain name
   single: Proxy
   double: Email; Domain
   double: Email; Configuration
   double: Site; Address

... change the host name?

GroupServer uses two slightly different host names: one for the web-site and one for the mail-host. To change the host name for the site both will have to be changed.


.. index::
   single: User group
   double: Site; Start

... create a new site?

GroupServer can handle more than one site. Each site will have its own set of groups, while the profiles will be shared between the sites. Sadly, the process is very manual, and prone to problems.

  1. Copy the folder for the initial site.
    1. Visit the :file:`/groupserver/Content` folder in the :ref:`ZMI <ZMI Login>`.
    2. Select the folder.
    3. Click the :guilabel:`Copy` button.
    4. Click the :guilabel:`Paste` button to paste it into the :file:`/groupserver/Content` folder.
    5. Select the new folder.
    6. Click the :guilabel:`Rename` button.
    7. Give the folder a new unique name. The new name must be unique among the sites, and all the groups.
    8. Click the :guilabel:`Ok` button.
  2. Create a new user group for the site.
    1. Visit :file:`/groupserver/acl_users`
    2. Select the :guilabel:`User Groups` tab.
    3. Click the :guilabel:`Add...` button.
    4. Set the :guilabel:`Name` of the new user group to {site-name}_member, where {site-name} is the name of your site.
    5. Click the :guilabel:`Add` button.
  3. Update the site configuration.
    1. Update the site title.
      1. Visit the folder for your new site.
      2. Select the :guilabel:`Properties` tab.
      3. Edit the title.
      4. Click the :guilabel:`Ok` button.
    2. Update the URL
      1. Visit the :file:`DivisionConfiguration` in the folder for your new site.
      2. Set the following at a minimum.
        • Update canonicalHost to be the hostname of your site.
        • Ensure that canonicalPort is correct. If this site is going to be an HTTP site canonicalPort should be 80; for HTTPS it should be 443
        • Add a new property named emailDomain. This is the domain used after the @ in the email addresses for the groups on the site. It may be the same as canonicalHost or different.
      3. Click the :guilabel:`Save Changes` button.
  4. Delete the groups.
    1. Visit the :file:`groups` folder in your new site.
    2. Select all the groups.
    3. Click the :guilabel:`Delete` button.
  5. Set the permissions.
    1. Visit the folder for your new site.
    2. Select the :guilabel:`Security` tab.
    3. Click :guilabel:`local roles` at the top of the page.
    4. :ref:`Set yourself as a site administrator. <multipleAdmin>`
    5. Set the user-group.
      1. Select the name of the user-group for the site from the :guilabel:`Group` list.
      2. Select DivisionMember from the :guilabel:`Roles` list.
      3. Click the :guilabel:`Add` button.
  6. Add :doc:`the proxy configuration <proxy-configure>` for your new site.
  7. Add :doc:`the Postfix configuration <postfix-configure>` for your new site.

<> <>

.. index::
   triple: Group; Email address; Change

... change the email address for a group?

The email address for a group is normally the group-identifier followed by the domain name for the site. However, it can be changed:

  1. Open the list object in the :file:`/groupserver/ListManager` folder.
  2. Edit the mailto property to the new value.
  3. Click the Save changes button.


.. index:: !Footer

... change the footer?

To change the footer edit a file called footerlinks.xml in the ZMI.

  1. Log into the :ref:`ZMI <ZMI Login>`.

  2. Visit the file :file:`/groupserver/Templates/output/footerlinks.xml`.

  3. Change the contents of the page template to the footer you desire. Something like the following:

    <ul class="inline-list pull-right">
  4. Click the :guilabel:`Save Changes` button.


.. index::
   pair: Configuration; Host name

... change the host name?

The host-name is normally set during :doc:`installation. <groupserver-install>` However, it can be changed afterwards.

  1. Visit the :file:`/groupserver/` folder in the :ref:`ZMI <ZMI Login>`.
  2. Open the GlobalConfiguration object.
  3. Edit the canonicalHost property to the new value.
  4. Click the Save changes button.
  5. Visit the :file:`/groupserver/ListManager` folder.
  6. :ref:`Change the email address <changeEmail>` for every group in the folder


.. index::
   pair: Profile; Password

... change the password for another person?

For security reasons, people can only change their own passwords. GroupServer deliberately prevents administrators from changing the passwords of other members.

If someone has forgotten their password then they should use the Password reset to set a new password. The page is linked from the Sign in page.


.. index:: !Reply-to

... change the Reply-to behaviour for a group?

GroupServer sets the email address in the :mailheader:`Reply-to` header when sending a message from a group. The address can be that of the group, the author, or both. The default :mailheader:`Reply-to` is set depending according to the type of group.

Group type Default :mailheader:`Reply-to`
Discussion Group
Announcement Author
Support Author

To change the default :mailheader:`Reply-to`

  1. Visit the Group page.
  2. Select :guilabel:`Change the general properties` in the :guilabel:`This group` section of the :guilabel:`Admin` area.
  3. Select the new setting from :guilabel:`Email replies go to…`
  4. Click the :guilabel:`Change` button.

[From Support]

.. index:: !Support
   pair: Support; Email

... change the support email?

The email address for support is first set during the :doc:`GroupServer installation. <groupserver-install>` To change it

  1. Visit the :file:`/groupserver/` folder in the :ref:`ZMI <ZMI Login>`,
  2. Open the GlobalConfiguration object, and
  3. Edit the supportEmail property.
  4. Click the Save changes button.


.. index:: !Editable page

... create a page?

Some pages in GroupServer (such as /about) are editable.

  1. Visit the folder that should contain the page in the :ref:`ZMI <ZMI Login>`.
  2. Add a new folder.
  3. Visit the new folder.
  4. Select the Interfaces tab.
  5. Select Products.GSContentManager.interfaces.IGSContentManagerFolderMarker in the Available Marker Interfaces list.
  6. Click the Add button.


.. index::
   pair: Email; Delete
   pair: Email; Hide

... delete a post?

Once a post has been made then the group members will receive an email message containing that post, and there is no way to recall the message. However, a post can be hidden in the archive: click the :guilabel:`Hide` button next to the post. The post will be replaced with a message saying why it was deleted.

To actually delete a post:

  • Any associated files must be removed from the file table,
  • The first_post_id, last_post_id and num_posts must be updated in the topic table, and
  • The post itself must be removed from the post table.

After deleting a post anyone following a link to the post on the archive (from the earlier message) will see a 404 (Not found) error rather than the nicer 410 (Gone) error.


.. index:: !DMARC
   pair: Email; DMARC

... disable email address obfuscation?

You cannot disable this feature. If a person posts from a domain controlled by DMARC (RFC 7489) then GroupServer rewrites the :mailheader:`From` header so others will receive the message. (If this was skipped then the message will fail the DMARC check and the group members would never see the message.) This conforms to the draft DMARC interoperability specification.


.. index::
   pair: Email; Formatting

... disable HTML email

HTML formatted email messages from a group can be disabled for an entire site.

  1. Log into the :ref:`ZMI <ZMI Login>`.
  2. Visit the :file:`DivisionConfiguration` for your site (by default :file:`/groupserver/Content/initial_site/`).
  3. Add the htmlEmail property.
    1. Add htmlEmail to the :guilabel:`Name` entry.
    2. Select boolean as the :guilabel:`Type`.
    3. Leave the :guilabel:`Value` as blank (False).
    4. Click the :guilabel:`Add` button.

To enable HTML formatted email messages either delete the htmlEmail property, or set it to True.

[From Support]

.. index::
   pair: Email; Import

... import posts from another system?

To import posts from another system first export the posts as an mbox file, then use the :command:`mbox2gs` script to import the posts into GroupServer (documentation).


.. index::
   triple: Group; Member; Moderate

... make all the members of a group moderated?

Ideally you would change the moderation of a group to Moderate specified members, and all new members that join this group before the new members are added. However, if this was skipped, and a large number of people has been added, then it is possible to set the list of moderated members.

  1. Visit the :file:`/groupserver/` folder in the :ref:`ZMI <ZMI Login>`.
  2. Open the acl_users object.
  3. Select the User groups tab.
  4. Open the user-group.
  5. Copy the list of user-identifiers from the Users list into a text editor.
  6. Remove the identifiers for each the administrator and moderator.
  7. Visit the :file:`/groupserver/ListManager` folder in the ZMI.
  8. Open the mailing list object for the group.
  9. Copy the list of members to be moderated from the text editor into the moderated_members list.
  10. Click the :guilabel:`Save changes` button.


.. index::
   pair: User; Delete
   pair: Profile; Delete

... remove a user?

When a person leaves their last group on a site they are no longer a site member, but they will still have a user-object. These objects can be deleted, but it is discouraged.

  1. Visit the :file:`/groupserver/` folder in the :ref:`ZMI <ZMI Login>`,
  2. Open the acl_users object,
  3. Select the user-object to delete, and
  4. Click the Delete button.


.. index::
   pair: Email; Virus scan

... scan for viruses?

Install pyClamd.


.. index:: !Security, DMARC, DKIM, SMTPS, HTTPS

... secure GroupServer?

Ensuring the following should enhance your security, and the members of your site should notice very little change.

  • The GroupServer site should only be accessible via HTTPS (as in HTTP over TLS). See :ref:`secure connections`.
  • Postfix should be using SMTPS (as in SMTP over TLS).
  • Postfix should be grey-listing all incoming messages.
  • Postfix should be running DMARC checks for all incoming messages.
  • Postfix should add DKIM signing to messages from the groups.
  • Scan for viruses.
  • Keep the operating system up to date.
  • Keep GroupServer up to date.


.. index:: Support
   triple: Group; Type; Support

... set multiple people to receive the support email?

The easiest way for multiple people to receive messages to the Support email address is to create a new Support group.

  1. Start a secret group.
  2. Change the group type to Support.
  3. Add the people who need to receive the messages to support to the group.
  4. :ref:`Change the support email address <changeSupport>` to the email address of the new group.


... turn off a feature?

Normally the easiest way to turn off a feature is to hide it in the CSS.

  1. Get used to :ref:`changing the skin. <skin>`
  2. Make your own skin, based off the Blue or Green skin (see :doc:`development`).
  3. Hide the interface element in question by setting it to display: none.

For example:

.. index:: Web page

Why do I see...

.. index::
   pair: Install; CentOS
   pair: Install; PostgreSQL
   pair: Install; RHEL

... an error setting up the database?

Towards the end of the GroupServer installation process the system will try and create some tables. If the permissions for :program:`PostgreSQL` are set to IDENT based authentication you will see the following error:

psql: FATAL: Ident authentication failed for user "gsadmin"

Change the :program:`PostgreSQL` authentication to md5.

  1. Open the file :file:`pg_hba.conf`. (It is normally found within :file:`/etc/postgresql`, but the specific location depends on your version of :program:`PostgreSQL` and distribution.)

  2. Change ident to md5 in the lines that read:

    host  all  all  ident
    host  all  all  ::1/128       ident

    They should end up like the following:

    host  all  all  md5
    host  all  all  ::1/128       md5
  3. Restart :program:`PostgreSQL`.


.. index::
   pair: Install; Distribute

... an error with distribute?

Sometimes there is an issue with installing the distribute package:

Error: There is a version conflict
We already have : distribute 0.6.24

The solution is

  1. Go to your GroupServer folder,

  2. Get :command:`pip` to install the correct version of distribute:

    $ ./bin/pip install "distribute == 0.6.49"
  3. Carry on installing GroupServer:

    $ ./


.. index:: !lxml
   pair: Install; Buildout

... "couldn't install: lxml"?

To compile lxml the system needs at least 1024M of RAM.


.. index:: Skin
   pair: Email; Skin

... email messages with the wrong CSS?

The web-hook that adds a message may use different URL to the one used for normal web traffic (see :ref:`skin`). If this is the case GroupServer may have to be explicitly told the skin to use.

  1. Visit the :file:`/groupserver/` folder in the :ref:`ZMI <ZMI Login>`,
  2. Open the GlobalConfiguration object,
  3. Set the emailSkin property to the same value that is used in the proxy configuration.


.. index::
   pair: Notification; Topic digest

... "Error with the configuration file" when sending the digest?

Specify the full path to the :file:`gsconfig.ini` on the command line to :command:`senddigest`. (See also :ref:`cronDigest`.)


... no email when I make a post?

If you are testing, ensure that your group members are on :guilabel:`One email per post`.


.. index:: Proxy, Web proxy, Postfix
   pair: Configuration; Proxy

... Request Entity Too Large?

Email messages are added to GroupServer, by :doc:`postifx, <postfix-configure>` using a web-hook. Because of this the :doc:`proxy <proxy-configure>` can block a message if it is too large. Adjust the client_max_body_size parameter in :program:`nginx` or similar variable in your proxy of choice.


.. index:: !root

... so many errors when installing?

GroupServer can only run as a normal user, never as the root superuser. Change the ownership of the GroupServer directory and all of its contents to a normal user.