You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by hu...@apache.org on 2023/02/20 20:52:23 UTC

[superset] 01/01: add docs section for ssh tunneling

This is an automated email from the ASF dual-hosted git repository.

hugh pushed a commit to branch ssh-tunnel-docs
in repository https://gitbox.apache.org/repos/asf/superset.git

commit 6aa53460ff18d59c4e74726a3ae01edccb024040
Author: hughhhh <hu...@gmail.com>
AuthorDate: Mon Feb 20 15:52:00 2023 -0500

    add docs section for ssh tunneling
---
 docs/docs/installation/setup-ssh-tunneling.mdx | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/docs/docs/installation/setup-ssh-tunneling.mdx b/docs/docs/installation/setup-ssh-tunneling.mdx
new file mode 100644
index 0000000000..44654c173d
--- /dev/null
+++ b/docs/docs/installation/setup-ssh-tunneling.mdx
@@ -0,0 +1,16 @@
+---
+title: Setup SSH Tunneling
+hide_title: true
+sidebar_position: 13
+version: 1
+---
+
+## SSH Tunneling
+
+1. Turn on feature flag
+    - Change (this value)[https://github.com/apache/superset/blob/master/superset/config.py#L489] to `True`
+    - If you want to add more security when establish the tunnel we allow users to overwrite the `SSHTunnelManager` class (here)[https://github.com/apache/superset/blob/master/superset/config.py#L507]
+    - You can also set the (`SSH_TUNNEL_LOCAL_BIND_ADDRESS`)[https://github.com/apache/superset/blob/master/superset/config.py#L508] this the host address where the tunnel will be accessible on your VPC
+
+2. Create database w/ ssh tunnel enabled
+    - Superset allows for 2 different type authenticaion (Basic + Private Key). These credentials should come from your service provider.