Development of Petals Cockpit is now stopped, you can still download released versions or fork the repository.

Petals Cockpit

Running demo (mock) https://linagora.gitlab.io/petals-cockpit

• Username: admin
• Password: admin

Trying Petals Cockpit

Running the pre-compiled JAR

1. Download the latest compiled petals-cockpit:

• Version 1.11.0
• Version Latest

2. Unpack it and go into the directory
3. Run Petals Cockpit:

$ ./petals-cockpit.sh

Running a docker image

from root folder

Build: docker build -t petals-cockpit .

Run: docker run -p 3600:8484 -it petals-cockpit

For the first run, remember to take a look at the terminal, where you should find an URL with a user setup token.

Otherwise, just go to http://localhost:3600.

Build an Executable Petals Cockpit

In order to create an executable product, simply build the frontend, the backend and then the product that will embed both of them:

• Build the frontend

$ cd frontend && yarn run build:product && cd ..

• Build Petals Cockpit (it will also build the backend)

$ mvn -s ci/settings.xml clean verify antrun:run@build-product-dist

The final distribution directory will be in cockpit/target/dist.

Running

Don't forget to first initialise the database (see below).

Execute Petals Cockpit:

$ java -jar cockpit/target/petals-cockpit-*-capsule.jar server cockpit/default.yml

Available Commands

The database can be initialised or migrated to the latest version with:

$ java -jar cockpit/target/petals-cockpit-*-capsule.jar db migrate cockpit/default.yml

An admin can be added with:

$ java -jar cockpit/target/petals-cockpit-*-capsule.jar add-user -u username -n Name -p password -a cockpit/default.yml

Or a normal user:

$ java -jar cockpit/target/petals-cockpit-*-capsule.jar add-user -u username -n Name -p password cockpit/default.yml

A workspace can also be generated with:

$ java -jar cockpit/target/petals-cockpit-*-capsule.jar add-user -u username -n Name -p password -w myWorkspace -a cockpit/default.yml

Working with the backend and the frontend separately

To execute backend commands, you can use:

$ cd backend/
$ mvn -s ../ci/settings.xml compile exec:java@cli -Dexec.args="db migrate default.yml"

The following command will simply execute the backend:

$ cd backend/
$ mvn -s ../ci/settings.xml compile dependency:properties exec:exec@server

To work on the frontend without mock (i.e., with the backend previously started):

$ cd frontend/
$ yarn run proxy

Backend REST API

Documentation about ressources served by the backend are available here : https://linagora.gitlab.io/petals-cockpit/apidocs/

Copyright and License

Petals Cockpit is made by Linagora under the AGPLv3 license, see LICENSE.md.