ac-play-java /app/views/ac/internal/production_doc.scala.html

Language HTML Lines 44
MD5 Hash 88a0abeac04a240a1eaf8f43ee467a66
Repository https://bitbucket.org/awei/ac-play-java.git View Raw File
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
@import com.atlassian.connect.play.java.Constants

@ac.internal.page("production") {
} {
    <h2>Preparing for production</h2>

    <p>
        Here are a few steps you should go through to configure you add-on and your environment before deploying it in
        production.
    </p>

    <h3>Set your add-on key (and name)</h3>
    <p>
        By default the module defines an add-on key for you when in development. If you haven't done so, set your add-on
        key (and name) in the <code>application.conf</code> file:
        <dl>
           <dt><code>@Constants.AC_PLUGIN_KEY</code></dt>
           <dd>your add-on key, which is used internally as a key by Atlassian Connect.</dd>
            <dt><code>@Constants.AC_PLUGIN_NAME</code></dt>
           <dd>your add-on name, which is used to display the name of you add-on to end users.</dd>
        </dl>
    </p>

    <h3>Set your base URL</h3>
    <p>
        By default the base URL is computed by the framework. When deploying to a production instance you should define
        the <code>BASE_URL</code> environment variable which will then be used as the base URL for your add-on.
    </p>

    <h3>Set your RSA keys</h3>
    <p>
        By default (in dev) the module generates a key pair to use for signing OAuth request when communicating with the
        host application. Those key files must NOT be used in production.
    </p>
    <p>
        Instead you should define them as environment variables on your production system:
       <dl>
           <dt><code>OAUTH_LOCAL_PUBLIC_KEY</code></dt>
           <dd>is your public key</dd>
           <dt><code>OAUTH_LOCAL_PRIVATE_KEY</code></dt>
           <dd>is your private key</dd>
       </dl>
    </p>
}
Back to Top