Atlassian Connect Play Seed

This project serves as a starter for Atlassian Connect add-ons based on Atlassian Connect Play.

Quick start

1. Start by cloning this repository

2. Install ngrok

   To install a Atlassian Connect add-on on a Cloud instance it has to be served over HTTPS. This can easily be done using ngrok. Make sure you have it installed and a tunnel started using

       ngrok http 9000
   

   ngrok will display the base URL for your add-on. Use it to configure the AC_BASE_URL parameter in the run configuration.

3. Configure the Play application

   You can configure your Play application via conf/application.conf. Atlassian Connect Play provides the following configuration parameters:

    atlassian.connect {
      key = io.toolsplus.acplayscala
      name = "Atlassian Connect Play"
      baseUrl = "localhost:9000"
      allowReinstallMissingHost = true
    }
   

   atlassian.connect.key is your add-on's unique key atlassian.connect.name is your add-on's name that you can choose freely atlassian.connect.baseUrl is your ngrok HTTPS URL if you develop locally, otherwise the HTTPS URL of where your add-on lives atlassian.connect.allowReinstallMissingHost when set to true will not allow to re-install a missing host, should be set to false for developer purposes

4. Configure a database

   This project is configured to use Postgres backend storage via Atlassian Connect Play Slick. Follow the guide there on how to configure a different database system if you wish to use something else.

That's it. You're add-on should now be ready to go.

Configuration via environment variables

Alternatively to configuring your add-on via conf/application.conf you can configure some properties via environment variables. The following lists the parameters available by default:

AC_BASE_URL=https://my-host.ngrok.io
AC_ALLOW_REINSTALL_MISSING_HOST=true
SLICK_DBS_DEFAULT_DRIVER=slick.driver.PostgresDriver$
SLICK_DBS_DEFAULT_DB_URL=jdbc:postgresql:acpsseed
SLICK_DBS_DEFAULT_DB_DRIVER=org.postgresql.Driver
SLICK_DBS_DEFAULT_DB_USER=sa
SLICK_DBS_DEFAULT_DB_PASSWORD=

If you need other parameters exposed as environment variables you can easily add then to the conf/application.conf. See examples in conf/application.conf on how to do this.

Contributing

Pull requests are always welcome. Please follow the contribution guidelines.

License

atlassian-connect-play-seed is licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.