The Radicale frontend of Modoboa
Python JavaScript Vue Makefile HTML
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.rst

modoboa-radicale

travis codecov Code Health

The Radicale frontend of Modoboa.

Installation

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

$ pip install https://github.com/modoboa/caldav/tarball/master#egg=caldav
$ pip install modoboa-radicale

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

  • add modoboa_radicale inside the MODOBOA_APPS variable like this:

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

    from modoboa_radicale import settings as modoboa_radicale_settings
    modoboa_radicale_settings.apply(globals())
    

Run the following commands to setup the database tables:

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

Finally, restart the python process running modoboa (uwsgi, gunicorn, apache, whatever).

For developpers

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 dev

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

$ npm run build