Note: If you have not already done so, download and extract the latest package from the releases page

So you're ready to set Postfacto up, choose a name for your app. We'll refer to this as app-name from now on.

Pivotal Web Services provides a hosted version of Pivotal's Cloud Foundry platform and is probably the easiest place to get Postfacto up and running.

1. Sign up for a PWS account, install the CF CLI and set yourself up with an organization and space by following the instructions here

2. Once logged in to PWS, add a database and a Redis service instance to your space from the Marketplace. We recommend the free plans of ElephantSQL and Redis Cloud respectively for this. Name these services postfacto-db and postfacto-redis

3. Run the PWS deployment script from the pws directory:

   ./deploy.sh <app-name>

4. Log in to the admin dashboard (email: [email protected] and password: password) to check everything has worked at <app-name>.cfapps.io/admin

5. Create a retro for yourself by clicking on 'Retros' and the 'New Retro'

6. Log in to your retro at <app-name>.cfapps.io/retros/your-retro-slug

7. Share the URL and password with your team and then run a retro!

1. Presuming the steps in the Initial deployment section have been completed, run the upgrade script from the pws directory:

   ./upgrade.sh <app-name>

1. If you'd previously deployed a version of Postfacto prior to 4.0, run the migration script from the pws directory:

   ./migrate.sh <web-app-name> <api-app-name>

   Note that the admin panel will move from <api-app-name>.cfapps.io/admin to <web-app-name>.cfapps.io/admin and the API app will be deleted

1. Set yourself up with an organization and space in your PCF to deploy your Postfacto to.

2. Take note of your PCF url, going forward referred to as pcf-url

3. Add a database (Postgres or Mysql) and a Redis service instance to your space from the Marketplace. Name these services postfacto-db and postfacto-redis.

4. Run the PCF deployment script from the pcf directory:

   ./deploy.sh <app-name>

5. Log in to the admin dashboard (email: [email protected] and password: password) to check everything has worked at <app-name>.<pcf-url>/admin

6. Create a retro for yourself by clicking on 'Retros' and the 'New Retro'

7. Log in to your retro at <app-name>.<pcf-url>/retros/your-retro-slug

8. Share the URL and password with your team and then run a retro!

1. Presuming the steps in the Initial deployment section have been completed, run the upgrade script from the pcf directory:

   ./upgrade.sh <app-name>

1. If you'd previously deployed a version of Postfacto prior to 4.0, run the migration script from the pcf directory:

   ./migrate.sh <web-app-name> <api-app-name>

   Note that the admin panel will move from <api-app-name>.<pcf-url>/admin to <web-app-name>.<pcf-url>/admin and the API app will be deleted

1. Install the Heroku CLI

2. Run the Heroku deployment script from the heroku directory:

   ./deploy.sh <app-name>

3. Log in to the admin dashboard (email: [email protected] and password: password) to check everything has worked at <app-name>.herokuapp.com/admin

4. Create a retro for yourself by clicking on 'Retros' and the 'New Retro'

5. Log in to your retro at <app-name>.herokuapp.com/retros/your-retro-slug

6. Share the URL and password with your team and then run a retro!

1. Presuming the steps in the Initial deployment section have been completed, run the upgrade script from the heroku directory:

   ./upgrade.sh <app-name>

⚠️ Warning: the Heroku migration will attempt to migrate your data to a new database instance and delete the old one. Take a look at what the script is doing and make sure you understand the implications before running it.

1. If you'd previously deployed a version of Postfacto prior to 4.0, run the migration script from the heroku directory:

   ./migrate.sh <web-app-name> <api-app-name>

   Note that the admin panel will move from <api-app-name>.herokuapp.com/admin to <web-app-name>.herokuapp.com/admin and the API app will be deleted

In order for users to sign-up and create their own retros using the web UI, Postfacto needs Google OAuth setup. For deployments that do not want to setup Google OAuth, you will need to create your retros through the admin console of your server via <app-name>.cfapps.io/admin or <app-name>.<pcf-url>/admin.

1. Go to Google Cloud Console and create a new project
2. Go to APIs & Services > Credentials > Create Credentials > OAuth client ID > Web application
3. Choose a name for your app
4. In Authorized JavaScript Origins, set it to the public URL of your app-name. For example: if deploying to PWS, your public URL will be https://<app-name>.<pcf-url>
5. You can leave redirect blank
6. Take note of your client-id that is generated
7. Add "google_oauth_client_id": {{client-id}} to the config.js for your installation.

If you'd like to have your instance send analytics data to the Postfacto team so they can learn about how you're using it and continue to improve it you can! To switch this on add "enable_analytics": true to the config.js object for your installation. Please note that we do not record any personal data (such as emails or retro data). As we are recording events from you we will however see the URL of the web client for your instance. If you're not comfortable with this don't worry, this feature is disabled by default.

You can customise this window with the SESSION_TIME env variable to the env on deploy. To set a session time of 1 hour for example:

SESSION_TIME=60 ./deploy <app-name>