Skip to content

Commit

Permalink
V1.8.1 docpatch (#1181)
Browse files Browse the repository at this point in the history
* fix docs links

* add to antora
  • Loading branch information
IrinaSouth authored Sep 5, 2024
1 parent 8a15326 commit 1e168fe
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ content:
- v1.7.0
- v1.7.1
- v1.8.0
- v1.8.1
- v1.8.1-docpatch
start_path: docs
- url: https://github.com/featurehub-io/featurehub-saas-docs
branches:
Expand Down
9 changes: 5 additions & 4 deletions docs/modules/ROOT/pages/configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -347,18 +347,19 @@ audit.logging.user=true
----

[#_encryption]
==== Encryption

To enable link:slack-integration.adoc[Slack integration] or URL and header encryption for Webhooks,
To enable link:slack-integration[Slack integration] or URL and header encryption for Webhooks,
you will need to specify an encryption key/password to be used for these items which are encrypted at
rest (i.e. they are encrypted until they are explicitly used, in Slack's case they are encrypted
until the system is about to POST to Slack, in Webhooks the same is true).

Config options to enable encryption:

- `webhooks.encryption.password` - this is encryption key/password. Required for Slack integration to work. This can
- `webhooks.encryption.password` - this is encryption key/password.Required for Slack integration to work.This can
be set to anything, we recommend using a randomiser or password generator to set a reasonably long
key (16+ characters).
key (16+ characters).
- `webhooks.decryption.enabled` - this defaults to `false` - which means
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.
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.
Expand All @@ -367,7 +368,7 @@ NOTE: *If you are migrating from v1.8.0 to 1.8.1 only, earlier version not affec
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: +
1. Set this property with your own generated value, e.g. `webhooks.encryption.password=foobar`, then set `webhooks.decryption.enabled=true` +
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. +
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.
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.


===== Kubernetes
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/evaluation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ NOTE: `$HOME/tmp` is where you wish to store the database (h2).

If you wish to enable Slack integration or use encryption in your local database, add the
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
tokens are encrypted when in the database. See link:configuration.adoc#_encryption[configuration documentation] for more details.
tokens are encrypted when in the database. See link:configuration#_encryption[configuration documentation] for more details.

An alternative is to use the link:installation{outfilesuffix}#_evaluation_deployment[Docker Compose] based
evaluation example.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/slack-integration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

You can integrate FeatureHub with Slack to receive feature updates directly into a Slack channel.

IMPORTANT: For Open Source version there is a pre-condition to set an link:configuration.adoc#_encryption[encryption key]
IMPORTANT: For Open Source version there is a pre-condition to set an link:configuration#_encryption[encryption key]

image::slack-message-example.png[Slack install to workspace, 800]

Expand Down
6 changes: 3 additions & 3 deletions docs/modules/ROOT/pages/system-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ System Configuration pages can be accessed by users with Super Admin permission.
== Site Configuration (Open Source version only)

Site Configuration allows you to configure correct website URL for your FeatureHub app, for example this is a prerequisite for enabling Slack integration.
+

image::fh-website-url-config.png[FeatureHub system config website URL, 1500]

== Slack Configuration

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.
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.

link:configuration.adoc#_encryption[Encryption needs to be enabled and configured] to allow for Slack to be
link:configuration#_encryption[Encryption needs to be enabled and configured] to allow for Slack to be
enabled. Slack will not appear if and encryption key is not configured.

image::slack-system-config.png[Slack system config, 1500]
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/webhooks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ image:webhook-config.png[Webhook Config]

Webhooks configuration is designed to be per environment for a given application - you can have one webhook per environment.

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
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
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.

image:webhook_history.png[Webhook History]
Expand Down

0 comments on commit 1e168fe

Please sign in to comment.