https://github.com/toolsplus/atlassian-connect-play-seed

https://github.com/toolsplus/atlassian-connect-play-seed

Last synced: 10 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/toolsplus/atlassian-connect-play-seed
• Owner: toolsplus
• License: apache-2.0
• Created: 2017-03-27T05:54:50.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-01-27T01:47:03.000Z (about 3 years ago)
• Last Synced: 2025-03-18T10:15:30.013Z (about 1 year ago)
• Language: Scala
• Size: 298 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Atlassian Connect Play Seed

===========================

[![Build Status](https://github.com/toolsplus/atlassian-connect-play-seed/workflows/CI/badge.svg)](https://github.com/toolsplus/atlassian-connect-play-seed/actions)

[![codecov](https://codecov.io/gh/toolsplus/atlassian-connect-play-seed/branch/master/graph/badge.svg)](https://codecov.io/gh/toolsplus/atlassian-connect-play-seed)

This project serves as a starter for Atlassian Connect add-ons

based on [Atlassian Connect Play](atlassian-connect-play).

## Quick start

1. Start by cloning this repository 

1. 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](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](#run-configuration).

1. 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

    

1. Configure a database

    This project is configured to use Postgres backend storage via 

    [Atlassian Connect Play Slick](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](CONTRIBUTING.md).

    

## License

atlassian-connect-play-seed is licensed under the **[Apache License, Version 2.0][apache]** (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.

[atlassian-connect-play]: https://github.com/toolsplus/atlassian-connect-play

[atlassian-connect-play-slick]: https://github.com/toolsplus/atlassian-connect-play-slick

[ngrok]: https://ngrok.com/

[apache]: http://www.apache.org/licenses/LICENSE-2.0