Skip to content

modoboa/modoboa-contacts

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
.tx
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Address book plugin for Modoboa

gha codecov

Installation

Install this extension system-wide or inside a virtual environment by running the following command:

$ pip install modoboa-contacts

Edit the settings.py file of your modoboa instance and apply the following modifications:

  • add modoboa_contacts inside the MODOBOA_APPS variable like this:

    MODOBOA_APPS = (
        'modoboa',
        'modoboa.core',
        'modoboa.lib',
        'modoboa.admin',
        'modoboa.relaydomains',
        'modoboa.limits',
        'modoboa.parameters',
        # Extensions here
        # ...
        'modoboa_contacts',
    )
    
  • Add the following at the end of the file:

    from modoboa_contacts import settings as modoboa_contacts_settings
    modoboa_contacts_settings.apply(globals())
    

Finally, run the following commands to setup the database tables:

$ cd <modoboa_instance_dir>
$ python manage.py migrate
$ python manage.py collectstatic
$ python manage.py load_initial_data

For developers

The frontend part of this plugin is developed with VueJS 2 and requires nodejs and webpack.

Once nodejs is installed on your system, run the following commands:

$ cd frontend
$ npm install
$ npm run serve

To update dist files (the ones that will be distributed with the plugin), run:

$ npm run build