Skip to content

Commit 29b75f8

Browse files
authored
fix: Optimizing Heroku deployment: more configs, add collaboration support (outline#2838)
1 parent 355013a commit 29b75f8

File tree

2 files changed

+57
-5
lines changed

2 files changed

+57
-5
lines changed

Procfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
web: yarn start --services=web,websockets
1+
web: yarn start --services=web,websockets,collaboration
22
worker: yarn start --services=worker

app.json

+56-4
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,20 @@
3535
"required": true
3636
},
3737
"SECRET_KEY": {
38-
"description": "A secret key",
38+
"description": "A 32-character secret key, generate with openssl rand -hex 32",
3939
"generator": "secret",
4040
"required": true
4141
},
4242
"ENABLE_UPDATES": {
4343
"value": "true",
4444
"required": true
4545
},
46+
"ALLOWED_DOMAINS": {
47+
"description": "Comma separated list of domains to be allowed (optional). If not set, all domains are allowed by default when using Google OAuth to signin. Consider putting {your app name}.herokuapp.com and any domain you are binding on in this list.",
48+
"required": false
49+
},
4650
"URL": {
47-
"description": "https://{your app name}.herokuapp.com",
51+
"description": "https://{your app name}.herokuapp.com, or the domain you are binding to",
4852
"required": true
4953
},
5054
"GOOGLE_CLIENT_ID": {
@@ -55,8 +59,51 @@
5559
"description": "",
5660
"required": false
5761
},
58-
"ALLOWED_DOMAINS": {
59-
"description": "Comma separated list of domains to be allowed (optional). If not set, all Google apps domains are allowed by default",
62+
"AZURE_CLIENT_ID": {
63+
"description": "To configure Microsoft/Azure auth, you'll need to create an OAuth Client. See the guide for details on setting up your Azure App: https://wiki.generaloutline.com/share/dfa77e56-d4d2-4b51-8ff8-84ea6608faa4",
64+
"required": false
65+
},
66+
"AZURE_CLIENT_SECRET": {
67+
"description": "",
68+
"required": false
69+
},
70+
"AZURE_RESOURCE_APP_ID": {
71+
"description": "",
72+
"required": false
73+
},
74+
"OIDC_CLIENT_ID": {
75+
"description": "To configure generic OIDC auth, you'll need some kind of identity provider. See documentation for whichever IdP you use to acquire the following info; Redirect URI is https://<URL>/auth/oidc.callback",
76+
"required": false
77+
},
78+
"OIDC_CLIENT_SECRET": {
79+
"description": "",
80+
"required": false
81+
},
82+
"OIDC_AUTH_URI": {
83+
"description": "",
84+
"required": false
85+
},
86+
"OIDC_TOKEN_URI": {
87+
"description": "",
88+
"required": false
89+
},
90+
"OIDC_USERINFO_URI": {
91+
"description": "",
92+
"required": false
93+
},
94+
"OIDC_USERNAME_CLAIM": {
95+
"description": "Specify which claims to derive user information from. Supports any valid JSON path with the JWT payload",
96+
"value": "preferred_username",
97+
"required": false
98+
},
99+
"OIDC_DISPLAY_NAME": {
100+
"description": "Display name for OIDC authentication",
101+
"value": "OpenID",
102+
"required": false
103+
},
104+
"OIDC_SCOPES": {
105+
"description": "Space separated auth scopes.",
106+
"value": "openid profile email",
60107
"required": false
61108
},
62109
"SLACK_KEY": {
@@ -155,6 +202,11 @@
155202
"TEAM_LOGO": {
156203
"description": "A logo that will be displayed on the signed out home page",
157204
"required": false
205+
},
206+
"DEFAULT_LANGUAGE": {
207+
"value": "en_US",
208+
"description": "The default interface language. See translate.getoutline.com for a list of available language codes and their rough percentage translated.",
209+
"required": false
158210
}
159211
}
160212
}

0 commit comments

Comments
 (0)