You would like to work on Modoboa but you don’t know where to start? You’re at the right place! Browse this page to learn useful tips.
Then, just run the following command:
$ docker-compose up
It will start the docker environment and make a Modoboa instance
If you don’t want to use docker or need a more complex development setup, go to the next section.
Prepare a virtual environment¶
A virtual environment is a good way to setup a development environment on your machine.
To do so, run the following commands:
$ python3 -m venv <path> $ source <path>/bin/activate $ git clone https://github.com/modoboa/modoboa.git $ cd modoboa $ python setup.py develop $ pip install -r dev-requirements.txt
develop command creates a symbolic link to your local copy so
any modification you make will be automatically available in your
environment, no need to copy them.
Deploy an instance for development¶
Make sure to create a database before running this step. The format of the database url is also described in this page.
Now that you have a running environment, you’re ready to deploy a test instance:
$ cd <path> $ modoboa-admin.py deploy --dburl default:<database url> --domain localhost --devel instance $ python manage.py runserver
You’re ready to go! You should be able to access Modoboa at
admin:password as credentials.
Manage static files¶
Those dependencies are listed in a file called
located inside the
If you want to add a new dependency, just complete the
BOWER_INSTALLED_APPS parameter and run the following command:
$ python manage.py bower install
It will download and store the required files into the
Test your modifications¶
If you deployed a specific instance for your development needs, you can run the tests suite as follows:
> python manage.py test modoboa.core modoboa.lib modoboa.admin modoboa.limits modoboa.relaydomains
Otherwise, you can run the tests suite from the repository using tox.
Start a basic Modoboa instance¶
From the repository, run the following command to launch a simple instance with a few fixtures:
> tox -e serve
You can use admin/password to log in.
Build the documentation¶
If you need to modify the documenation and want to see the result, you can build it as follows:
> tox -e doc > firefox .tox/doc/tmp/html/index.html
bower command is missing in manage.py¶
bower command is missing in manage.py if you don’t use the
--devel option of the
modoboa-admin.py deploy command.
To fix it, regenerate your instance or update your
file manually. Look at