Automated setup for Stash

This page describes how the Stash Setup Wizard can be completed automatically, that is without the need for manual interaction in the browser. See Getting started for an outline of the tasks that the Setup Wizard assists with when setting up Stash manually.

You might want to configure this when automating the provisioning of Stash Data Center, for example. Of course, you'll need to configure provisioning tools such as Puppet or Vagrant yourself.

Note that you can also automate the 'install and launch' phase of provisioning Stash – see Running the Stash installer for information about how to run the installer in console and unattended modes.

1. Get a license for Stash

You can get a new Stash license by doing one of:

Logging in to your My.Atlassian.com account.
Contacting Atlassian, if you need a Stash Data Center license.

If you already have a licensed instance of Stash, you can find the license in the Stash admin area.

2. Set the configuration properties

After installing Stash, but before you start Stash for the first time, edit the stash-config.properties file to add the properties in the table below. Use the standard format for Java properties files.

Note that the stash-config.properties file is created automatically in the shared folder of your Stash home directory when you perform a database migration. Create the file yourself if it does not yet exist. See Stash config properties for information about the properties file.

Add these properties to the stash-config.properties file:

Property	Description
`setup.displayName=displayName`	The display name for the Stash application.
`setup.baseUrl= https://stash.yourcompany.com`	The base URL.
`setup.license=AAAB...\u000a1ev...\u000aA4N...`	The Stash license. Use the the `\u000` character to not break the license over multiple lines.
`setup.sysadmin.username=username`	Credentials for the system admin account.
`setup.sysadmin.password=password`	Credentials for the system admin account.
`setup.sysadmin.displayName=John Doe`	The display name for the system admin account. An empty property is ignored.
`setup.sysadmin.emailAddress=sysadmin@yourcompany.com`	The email address for the system admin account.
`jdbc.driver=org.postgresql.Driver`	JDBC connection parameters. Use the appropriate values for your own JDBC connection.
`jdbc.url=jdbc:postgresql://localhost:5432/stash`
`jdbc.user=stash`
`jdbc.password=stash`

You should specify the JDBC properties so that Stash can connect to the external database.

If any of the following required properties are not provided in the properties file, when you start Stash the Setup Wizard will launch at the appropriate screen so that you can enter values for those properties.

3. Start Stash

Start Stash as usual. See Starting and stopping Stash.

Stash reads the stash-config.properties file and applies the setup properties automatically.

When you now visit Stash in the browser, you see the welcome page.

Troubleshooting

The Setup Wizard launches in the browser

The Setup Wizard will run if there are missing configuration properties, such as the license string, in the stash-config.properties file. Check the properties file and compare with the table in Step 2 above. Alternatively, the set up can be completed using the web UI.

Write access for the `config.properties` file

Once the automated setup process completes, the relevant properties in the stash-config.properties file are commented out. This requires that the system user has write permission on the properties file.

Stash fails to start with a 'Could not acquire change log lock.' error

If Stash is forced to quit while modifying the config.properties file, you may not be able to restart Stash, and atlassian-stash.log contains the above error.

See this KB article for information about how to resolve this: Stash Does Not Start - Could not acquire change log lock

Page tree