How to

1. Clone this repository

2. Make sure you have the following folders (which will be used as volumes in Docker)

   /data
   /jenkins
   

   In fact, the /data can be placed anywhere on the file system and you will have to configure it during the setup of an environment for Probe Dock.

3. Make sure Docker and Docker Compose is installed and running

4. Run the following script (at the root of this directory). This script will build some images used in the Probe Dock infra and also start the Jenkins instance to manage the infra.

   ./start.sh
   

5. Once the script has ended, you can open your browser and access to :8080. You will get access to the following job:

   • OneClick: This job will drive all the operations required to deploy and maintain Probe Dock environments on Docker. The job will give you information about the operation you need to perform.

     In summary, you will have to choose between: Create a new environment or Update an existing environment. The second choice will only appear if there is at least one existing environment.

     For the creation of an environment, only one task is available: Setup the environment. This task will guide you through the configuration of the environment and will propose you to deploy the environment for the first time.

     Hint: Credentials are stored through credentials plugin and therefore can be updated through the plugin interface. Remark: Take care that updating a password will not change the password in the infra.

     For the maintenance of an environment, you will have the following tasks:

       * `Backup of the database`: Allow to make a backup of the PostgreSQL database. The Probe Dock application will be stopped before the backup and restarted after it.
     
       * `Create a new admin account`: Allow to create a new admin account on Probe Dock.
     
           **Hint**: You can use this job to create a new admin if you loose the previous admin password.
     
       * `Update an environment`: This task will allow you to update the configuration of an existing environment.
     
       * `Deploy a new version`: This task will deploy a new version of Probe Dock. If there is database migration, they will be done. Before the application is deployed, a backup of the database is done.
     
       * `Deploy a new version and load a database dump`: This task is pretty much the same than the previous one. Before running the migrations, we load the dump you have chosen in a list.
     
       * `Deploy for the first time`: This task allow to deploy Probe Dock for the first time. They are several things to prepare on the first time. Once done, this task will not be available anymore.
     

6. If everything worked well, you will be able to access your default environment through <host>:3000