You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 1, 2023. It is now read-only.
* Update README and deployment instructions to stop referring to Pivotal Cloud Foundry and instead just to Cloud Foundry
Signed-off-by: Othman Alkhamra <[email protected]>
* Add deployment script and instructions for TAS
Signed-off-by: Othman Alkhamra <[email protected]>
* Update Tanzu deployment instructions
* Update deployment instructions to clarify downloading the package first
* Replace CF with TAS in deploy-tas.sh
* Update deployment README for clarity
* Make README links relative
* Apply suggestions from code review
Tidy up wording around PWS/CF/TAS in upgrade and deploy instructions.
Co-authored-by: Jonathan Sharpe <[email protected]>
* Remove TAS migrate script as there will be no existing installations < 4.0.0
* Add table of contents to deployment readme
Co-authored-by: Brian Butz <[email protected]>
Co-authored-by: Jonathan Sharpe <[email protected]>
Copy file name to clipboardexpand all lines: README.md
+9-9
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Postfacto helps teams run great [retrospectives](https://content.pivotal.io/blog
14
14
Postfacto lets you run an agile retrospective even when your team is distributed across the world. Your retros will live update across all your devices so each participant can follow along on their device.
15
15
16
16
### Easy Onboarding
17
-
Easily [set up](https://github.com/pivotal/postfacto/tree/master/deployment#allowing-users-to-create-retros) Postfacto to work with Google OAuth so users can sign up with their Google accounts. Alternatively, you can control access to your instance with the admin dashboard.
17
+
Easily [set up](deployment/README.md#allowing-users-to-create-retros) Postfacto to work with Google OAuth so users can sign up with their Google accounts. Alternatively, you can control access to your instance with the admin dashboard.
18
18
19
19
### Run Public or Private Retros
20
20
You can create private retro boards for your team that are password protected or choose to leave them public so that anyone you give the link to can access them.
@@ -28,22 +28,22 @@ Retros are designed to help teams improve and that's hard to do without taking a
28
28
29
29
## Deployment
30
30
31
-
Postfacto is a self hosted product, this makes it easier for you to stay in control of your data. We aim to make it easy to deploy to as many locations as possible. We currently support the following:
31
+
Postfacto is a self hosted product, this makes it easier for you to stay in control of your data. We aim to make it easy to deploy to as many locations as possible.
First, download and extract the latest package from the [releases page](https://github.com/pivotal/postfacto/releases) before following the instructions below for your supported platform:
36
34
37
-
**Note: Download and extract the latest package from the [releases page](https://github.com/pivotal/postfacto/releases) before following the instructions above.**
If the platforms above don't work for you; you may be able to find a way to run Postfacto yourself by following the Contributing Guide.
40
41
41
42
## Contributing
42
43
43
-
See the [Contributing Guide](https://github.com/pivotal/postfacto/blob/master/CONTRIBUTING.md) for more info.
44
+
See the [Contributing Guide](CONTRIBUTING.md) for more info.
44
45
45
46
## License
46
47
47
48
Postfacto is licensed under the **GNU Affero General Public License** (often referred to as **AGPL-3.0**). The full text
48
-
of the license is available [here](https://github.com/pivotal/postfacto/blob/master/LICENSE.md). It's important to note
49
-
that this license allows you to deploy an instance of Postfacto for private, public or internal use.
49
+
of the license is available [here](LICENSE.md). It's important to note that this license allows you to deploy an instance of Postfacto for private, public or internal use.
Copy file name to clipboardexpand all lines: deployment/README.md
+58-25
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,47 @@
1
1
# Deployment
2
2
3
-
**Note: If you have not already done so, download and extract the latest package from the [releases page](https://github.com/pivotal/postfacto/releases)**
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.
11
+
## Prerequisites
12
+
1. Download and extract the latest package from the [releases page](https://github.com/pivotal/postfacto/releases)
13
+
2. Choose a name for your app, we'll refer to this as `app-name` from now on
14
+
15
+
## Tanzu Application Service
16
+
17
+
#### Initial deployment
18
+
19
+
1. Set yourself up with an organization and space in your TAS account to deploy Postfacto to.
20
+
1. 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`.
21
+
1. Run the TAS deployment script from the `tas` directory:
22
+
23
+
```bash
24
+
./deploy.sh <app-name>
25
+
```
26
+
27
+
Take note of the URL that has shown up in the `routes:` section of the script output, going forward referred to as `<app-url>`.
28
+
1. Log in to the Postfacto admin dashboard (email: `[email protected]` and password: `password`) to check everything has worked at `<app-url>/admin`
29
+
1. Create a retro for yourself by clicking on 'Retros' and the 'New Retro'
30
+
1. Log in to your retro at `<app-url>/retros/your-retro-slug`
31
+
1. Share the URL and password with your team and then run a retro!
32
+
33
+
#### Upgrading a deployment
34
+
35
+
1. Presuming the steps in the Initial deployment section have been completed, run the upgrade script from the `tas` directory:
36
+
```bash
37
+
./upgrade.sh <app-name>
38
+
```
6
39
7
40
## Pivotal Web Services
8
41
9
-
### Initial deployment
42
+
#### Initial deployment
10
43
11
-
[Pivotal Web Services](https://run.pivotal.io) provides a hosted version of Pivotal's [Cloud Foundry](https://pivotal.io/platform) platform and is probably the easiest place to get Postfacto up and running.
44
+
[Pivotal Web Services](https://run.pivotal.io) provides a hosted version of VMware's [Tanzu Application Service](https://tanzu.vmware.com/application-service) platform and is probably the easiest place to get Postfacto up and running.
12
45
13
46
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](https://docs.run.pivotal.io/starting/)
14
47
1. 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`
@@ -17,81 +50,81 @@ So you're ready to set Postfacto up, choose a name for your app. We'll refer to
17
50
```bash
18
51
./deploy.sh <app-name>
19
52
```
20
-
1. Log in to the admin dashboard (email: `[email protected]` and password: `password`) to check everything has worked at `<app-name>.cfapps.io/admin`
53
+
1. Log in to the Postfacto admin dashboard (email: `[email protected]` and password: `password`) to check everything has worked at `<app-name>.cfapps.io/admin`
21
54
1. Create a retro for yourself by clicking on 'Retros' and the 'New Retro'
22
55
1. Log in to your retro at `<app-name>.cfapps.io/retros/your-retro-slug`
23
56
1. Share the URL and password with your team and then run a retro!
24
57
25
-
### Upgrading a deployment
58
+
#### Upgrading a deployment
26
59
27
60
1. Presuming the steps in the Initial deployment section have been completed, run the upgrade script from the `pws` directory:
28
61
```bash
29
62
./upgrade.sh <app-name>
30
63
```
31
64
32
-
### Migrating a deployment
65
+
#### Migrating a deployment
33
66
34
67
1. If you'd previously deployed a version of Postfacto prior to 4.0, run the migration script from the `pws` directory:
35
68
```bash
36
69
./migrate.sh <web-app-name><api-app-name>
37
70
```
38
71
**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
39
72
40
-
## Pivotal Cloud Foundry
73
+
## Cloud Foundry
41
74
42
-
### Initial deployment
75
+
#### Initial deployment
43
76
44
-
1. Set yourself up with an organization and space in your PCF to deploy your Postfacto to.
45
-
1. Take note of your PCF url, going forward referred to as `pcf-url`
77
+
1. Set yourself up with an organization and space in your CF to deploy your Postfacto to.
78
+
1. Take note of your CF url, going forward referred to as `cf-url`
46
79
1. 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`.
47
-
1. Run the PCF deployment script from the `pcf` directory:
80
+
1. Run the CF deployment script from the `cf` directory:
48
81
49
82
```bash
50
83
./deploy.sh <app-name>
51
84
```
52
-
1. Log in to the admin dashboard (email: `[email protected]` and password: `password`) to check everything has worked at `<app-name>.<pcf-url>/admin`
85
+
1. Log in to the Postfacto admin dashboard (email: `[email protected]` and password: `password`) to check everything has worked at `<app-name>.<cf-url>/admin`
53
86
1. Create a retro for yourself by clicking on 'Retros' and the 'New Retro'
54
-
1. Log in to your retro at `<app-name>.<pcf-url>/retros/your-retro-slug`
87
+
1. Log in to your retro at `<app-name>.<cf-url>/retros/your-retro-slug`
55
88
1. Share the URL and password with your team and then run a retro!
56
89
57
-
### Upgrading a deployment
90
+
#### Upgrading a deployment
58
91
59
-
1. Presuming the steps in the Initial deployment section have been completed, run the upgrade script from the `pcf` directory:
92
+
1. Presuming the steps in the Initial deployment section have been completed, run the upgrade script from the `cf` directory:
60
93
```bash
61
94
./upgrade.sh <app-name>
62
95
```
63
96
64
-
### Migrating a deployment
97
+
#### Migrating a deployment
65
98
66
-
1. If you'd previously deployed a version of Postfacto prior to 4.0, run the migration script from the `pcf` directory:
99
+
1. If you'd previously deployed a version of Postfacto prior to 4.0, run the migration script from the `cf` directory:
67
100
```bash
68
101
./migrate.sh <web-app-name> <api-app-name>
69
102
```
70
-
**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
103
+
**Note** that the admin panel will move from `<api-app-name>.<cf-url>/admin` to `<web-app-name>.<cf-url>/admin` and the API app will be deleted
71
104
72
105
## Heroku
73
106
74
-
### Initial deployment
107
+
#### Initial deployment
75
108
76
109
1. Install the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli)
77
110
1. Run the Heroku deployment script from the `heroku` directory:
78
111
79
112
```bash
80
113
./deploy.sh <app-name>
81
114
```
82
-
1. Log in to the admin dashboard (email: `[email protected]` and password: `password`) to check everything has worked at `<app-name>.herokuapp.com/admin`
115
+
1. Log in to the Postfacto admin dashboard (email: `[email protected]` and password: `password`) to check everything has worked at `<app-name>.herokuapp.com/admin`
83
116
1. Create a retro for yourself by clicking on 'Retros' and the 'New Retro'
84
117
1. Log in to your retro at `<app-name>.herokuapp.com/retros/your-retro-slug`
85
118
1. Share the URL and password with your team and then run a retro!
86
119
87
-
### Upgrading a deployment
120
+
#### Upgrading a deployment
88
121
89
122
1. Presuming the steps in the Initial deployment section have been completed, run the upgrade script from the `heroku` directory:
90
123
```bash
91
124
./upgrade.sh <app-name>
92
125
```
93
126
94
-
### Migrating a deployment
127
+
#### Migrating a deployment
95
128
96
129
> ⚠️ **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.
97
130
@@ -107,13 +140,13 @@ So you're ready to set Postfacto up, choose a name for your app. We'll refer to
107
140
108
141
In order for users to sign-up and create their own retros using the web UI, Postfacto needs Google OAuth setup.
109
142
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
110
-
`<app-name>.cfapps.io/admin` or `<app-name>.<pcf-url>/admin`.
143
+
`<app-name>.cfapps.io/admin` or `<app-name>.<cf-url>/admin`.
111
144
112
145
1. Go to [Google Cloud Console](https://console.cloud.google.com) and
113
146
create a new project
114
147
1. Go to APIs & Services > Credentials > Create Credentials > OAuth client ID > Web application
115
148
1. Choose a name for your app
116
-
1. 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>`
149
+
1. 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>.cfapps.io`
117
150
1. You can leave redirect blank
118
151
1. Take note of your `client-id` that is generated
119
152
1. Add `"google_oauth_client_id": {{client-id}}` to the `config.js`for your installation.
0 commit comments