2.2 Instructions

For detailed instructions and how to use other tools, such as the gradle integration for IntelliJ, please refer to the User Guide.

To get started, either git clone this-repository or download the latest release from this repository's releases page. If you cloned the repository, navigate to the repository folder. If you downloaded the zip file, extract it to a location of your choice and navigate there.

1. Open a terminal of your choice in the jazz-debug-environment folder. Eg. type powershell in the address bar of Windows Explorer.
2. Run ./gradlew bootstrap. If you are running this for the first time, setup might take a while to download and build all dependencies and the tool. This step will create the jde folder inside the current folder, with which you will work as a user.
3. This example will set up RTC SDK 6.0.6. Download the RTC Server SDK to the jde/sdks folder, and the JTS-CCM-Keys for Windows or JTS-CCM-keys for Linux to the jde/servers folder. You should now have a folder structure that looks similar to this (only relevant files shown):

jde
├── dbs
│   └── 6.0.6_db.zip
├── runtime
├── sdks
│   └── RTC-SDK-Server-6.0.6.zip
└── servers
    └── JTS-CCM-keys-Linux64_6.0.6.zip

4. Run ./gradlew setup. This will take some time to run, just wait for it to complete.
5. Run ./gradlew run to start a development instance of jazz. This will take a while to start when run for the first time. Do not be irritated by the many log warning and errors, the log level is quite verbose. After being patient for a while, you should be able to navigate to https://localhost:7443/jazz and be greeted by the Jazz Login Screen. You can use the credentials TestJazzAdmin1 / TestJazzAdmin1 to log in.
6. To stop the server, just press Ctrl + C inside the terminal window running jetty.

To continue exploring the features , refer to the User Guide. Have fun developing RTC plugins :)