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
Copy file name to clipboardExpand all lines: docs/modules/ROOT/pages/configuration.adoc
+5-4Lines changed: 5 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -347,18 +347,19 @@ audit.logging.user=true
347
347
348
348
----
349
349
350
+
[#_encryption]
350
351
==== Encryption
351
352
352
-
To enable link:slack-integration.adoc[Slack integration] or URL and header encryption for Webhooks,
353
+
To enable link:slack-integration[Slack integration] or URL and header encryption for Webhooks,
353
354
you will need to specify an encryption key/password to be used for these items which are encrypted at
354
355
rest (i.e. they are encrypted until they are explicitly used, in Slack's case they are encrypted
355
356
until the system is about to POST to Slack, in Webhooks the same is true).
356
357
357
358
Config options to enable encryption:
358
359
359
-
- `webhooks.encryption.password` - this is encryption key/password.Required for Slack integration to work.This can
360
+
- `webhooks.encryption.password` - this is encryption key/password.Required for Slack integration to work.This can
360
361
be set to anything, we recommend using a randomiser or password generator to set a reasonably long
361
-
key (16+ characters).
362
+
key (16+ characters).
362
363
- `webhooks.decryption.enabled` - this defaults to `false` - which means
363
364
1) Once Slack Bot User OAuth Token is set in the Admin app, it cannot be viewed again and will show as hidden. Set this to `true` to be able to view or change the token.
364
365
2) Once webhook URL or header value is set and an option to "Encrypt" is checked in the Admin app, they cannot be viewed again and will be shown as hidden. Set this to `true` to be able to view, delete or reset the webhook URL or header values.
@@ -367,7 +368,7 @@ NOTE: *If you are migrating from v1.8.0 to 1.8.1 only, earlier version not affec
367
368
The `webhooks.encryption.password` property was set at a default value in `1.8.0` but it was removed as a security precaution in `1.8.1`. It will affect your Slack integration if you used it in 1.8.0. You will need to: +
368
369
1. Set this property with your own generated value, e.g. `webhooks.encryption.password=foobar`, then set `webhooks.decryption.enabled=true` +
369
370
2. Go to FeatureHub Admin UI System Config page, select disable Slack checkbox, reveal and copy Slack Bot User OAuth Token then clear it and Save. Re-enter Slack Bot User OAuth Token and Save. This should re-enable Slack with new encryption key. +
370
-
If you cannot view and copy Slack Bot User OAuth Token, go to Slack Workspace settings here https://api.slack.com/apps and find FeatureHub app. Go to OAuth and Permissions screen and find your Slack Bot User OAuth Token.
371
+
If you cannot view and copy Slack Bot User OAuth Token, go to Slack Workspace settings here https://api.slack.com/apps and find FeatureHub app. Go to OAuth and Permissions screen and find your Slack Bot User OAuth Token.
Copy file name to clipboardExpand all lines: docs/modules/ROOT/pages/evaluation.adoc
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ NOTE: `$HOME/tmp` is where you wish to store the database (h2).
19
19
20
20
If you wish to enable Slack integration or use encryption in your local database, add the
21
21
option: `-e webhooks.encryption.password=<random-password>` - where `random-long-password` is a made up key, like you would get from a password generator. This is used to ensure secure third-party
22
-
tokens are encrypted when in the database. See link:configuration.adoc#_encryption[configuration documentation] for more details.
22
+
tokens are encrypted when in the database. See link:configuration#_encryption[configuration documentation] for more details.
23
23
24
24
An alternative is to use the link:installation{outfilesuffix}#_evaluation_deployment[Docker Compose] based
Copy file name to clipboardExpand all lines: docs/modules/ROOT/pages/system-configuration.adoc
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -5,14 +5,14 @@ System Configuration pages can be accessed by users with Super Admin permission.
5
5
== Site Configuration (Open Source version only)
6
6
7
7
Site Configuration allows you to configure correct website URL for your FeatureHub app, for example this is a prerequisite for enabling Slack integration.
8
-
+
8
+
9
9
image::fh-website-url-config.png[FeatureHub system config website URL, 1500]
10
10
11
11
== Slack Configuration
12
12
13
-
This is a global Slack setup page, which will help you to connect FeatureHub organisation (or deployed instance of Open Source version) with Slack. See more details on link:slack-integration.adoc[Slack integration] page.
13
+
This is a global Slack setup page, which will help you to connect FeatureHub organisation (or deployed instance of Open Source version) with Slack. See more details on link:slack-integration[Slack integration] page.
14
14
15
-
link:configuration.adoc#_encryption[Encryption needs to be enabled and configured] to allow for Slack to be
15
+
link:configuration#_encryption[Encryption needs to be enabled and configured] to allow for Slack to be
16
16
enabled. Slack will not appear if and encryption key is not configured.
17
17
18
18
image::slack-system-config.png[Slack system config, 1500]
Webhooks configuration is designed to be per environment for a given application - you can have one webhook per environment.
14
14
15
-
You can enable/disable a webhook, configure the url destination and any extra headers you need. Optionally you can enable encryption for URL and headers in the system config, see link:configuration.adoc#_encryption[encryption]. Once you have
15
+
You can enable/disable a webhook, configure the url destination and any extra headers you need. Optionally you can enable encryption for URL and headers in the system config, see link:configuration#_encryption[encryption]. Once you have
16
16
saved webhook settings, you can test it out. Test button will only appear if webhook is enabled. Switch to the Webhooks History sub-tab to see the webhook history results/logs.
0 commit comments